Name: metrics-collector-client-node
Owner: International Business Machines
Description: Node module for the deployment tracker
Forked from: IBM-Cloud/cf-deployment-tracker-client-node
Created: 2017-09-12 17:53:18.0
Updated: 2018-04-20 16:57:59.0
Pushed: 2018-04-20 16:59:34.0
Homepage: https://www.npmjs.com/package/metrics-tracker-client
Size: 36
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Metrics Collector Service collects statistics for deployment of a github sample code on Cloud Foundry, Kubernetes, Data Science Experience, OpenWhisk etc.
This is Node client for Metrics Collector Service. It is an npm module that can track and report details of a demo/tutorial that has been deployed to Cloud Foundry.
Open a terminal and run
install metrics-tracker-client --save
Require the package in your main entry point to your app (probably app.js).
ire("metrics-tracker-client").track();
Add a copy of the Privacy Notice to the readme file.
Note: All apps that have deployment tracker must include the Privacy Notice.
Add a repository.yaml file in the same directory of your main entry point files.
The repository.yaml need to be written in Yaml format. Also, please put all your keys in lower case.
https://github.com/IBM/watson-discovery-news
imes:
Cloud Foundry
ices:
Discovery
t_id: web
t_organizer: dev-journeys
uage: nodejs
Required field:
Please go to the service list page to get the list of official names for runtimes, services, and languages.
To see how to include this into your app please visit Watson Multimedia Analyzer. You will want to pay attention to package.json, repository.yaml, and app.js.
Sample web applications that include this package may be configured to track deployments to IBM Cloud and other Cloud Foundry platforms. The following information is sent to a Deployment Tracker service on each deployment:
application_name
)application_id
)instance_index
)space_id
) or OS usernameapplication_version
)application_uris
)cf_api
)This data is collected from the package.json
and repository.yaml
file in the sample application and the VCAP_APPLICATION
and VCAP_SERVICES
environment variables in IBM Cloud and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Cloud 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.
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.