Skip to main content

Python client for the deployment tracker

Project description

# Overview

[![Build Status](https://travis-ci.org/IBM-Bluemix/cf-deployment-tracker-client-python.svg?branch=master)](https://travis-ci.org/IBM-Bluemix/cf-deployment-tracker-client-python)

This is the source code for metrics_collector_client, a pip package that can track and report details of a demo/tutorial.

## How To Use It On Applications

  1. Open a terminal and run

    `bash pip install metrics-tracker-client `

  2. Import the package at the entry point of your app and call the track() function.

    `python import metrics_tracker_client metrics_tracker_client.track() `

  3. Add a copy of the Privacy Notice to the readme file.

    Note: All apps that have deployment tracker must include the Privacy Notice.

  4. Add a repository.yaml file in the same directory of your main entry point files.

## How To Use It On Jupyter Notebook 1. In your Jupyter Notebook, insert the following package and code in your entry point. Then, fill in the parameter in metrics_tracker_client.DSX with the format ‘<gitHub Organization>/<Repository name>’.

`python !pip install --upgrade -q metrics-tracker-client import metrics_tracker_client metrics_tracker_client.DSX('org/repo') `

  1. Add a copy of the Privacy Notice to the readme file.

    Note: All apps that have deployment tracker must include the Privacy Notice.

  2. Add a repository.yaml file in your GitHub’s top-level repository.

## Example app

To see how to include this into your app please visit [Bluemix Hello World](https://github.com/IBM-Bluemix/python-hello-world-flask). You will want to pay attention to [setup.py](https://github.com/IBM-Bluemix/python-hello-world-flask/blob/master/setup.py) and [hello.py](https://github.com/IBM-Bluemix/python-hello-world-flask/blob/master/hello.py).

## Privacy Notice

Sample web applications that include this package may be configured to track deployments to [IBM Bluemix](https://www.bluemix.net/) and other Cloud Foundry platforms. The following information is sent to a [Deployment Tracker](https://github.com/IBM/metrics-collector-service) service on each deployment:

  • Python package version

  • Python repository URL

  • Application Name (application_name)

  • Application GUID (application_id)

  • Application instance index number (instance_index)

  • Space ID (space_id)

  • Application Version (application_version)

  • Application URIs (application_uris)

  • Labels of bound services

  • Number of instances for each bound service and associated plan information

This data is collected from the setup.py and repository.yaml file in the sample application and the VCAP_APPLICATION and VCAP_SERVICES environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.

## Disabling Deployment Tracking

Please see the README for the sample application that includes this package for instructions on disabling deployment tracking, as the instructions may vary based on the sample application in which this package is included.

## License

See [License.txt](License.txt) for license information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metrics-tracker-client-1.0.7.tar.gz (4.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page