@ibm/telemetry-js - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "@ibm/telemetry-js",
   "description": "JavaScript telemetry tooling for open/inner source projects",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "license": "Apache-2.0",
@@ -6,0 +6,0 @@ "author": "IBM",

README.md

@@ -43,7 +43,24 @@ # IBM Telemetry JS
 
-When your project installs an IBM Telemetry-enabled (instrumented) package, IBM Telemetry performs
-source code analysis on your project to identify package and component usage. This helps IBM
-generate meaningful insights into exactly how much and in what ways the package code is being used
-across teams and projects.
+If you're reading this section, you're likely using a package and have noticed that it is collecting
+telemetry data using IBM Telemetry. We call that an "instrumented package". Here's what you need to
+know about how that works:
 
+- Telemetry data collection runs on CI servers, like GitHub Actions, Travis CI, or Jenkins. It never
+  runs locally on a developer's machine.
+- When `npm install` (or equivalent) is run on the CI server (resulting in the instrumented package
+  getting installed), IBM Telemetry gets installed too and runs a script which analyzes your source
+  code and captures data about your usage of the instrumented package.
+- This data is fully anonymized and reported back to a server at IBM.
+- For more details about exactly what is captured and how sensitive data is anonymized, keep
+  reading.
+- Though IBM Telemetry is installed as a regular dependency in the instrumented package, it has no
+  exports and therefore **does not impact your project's source code or build output in any way.**
+  Said differently: This is not a runtime package. It has no "shippable code". It is static source
+  code analysis performed during builds and nothing more.
+
+The point of capturing this data is to help the open source and inner source maintainers within IBM
+by giving them meaningful insights and metrics based on actual data. IBM Telemetry's purpose is to
+enable data-driven decision-making to enable maintainers to focus on features that are actually used
+by developers like you.
+
 ### What data gets collected?
@@ -59,2 +76,3 @@
 - A de-identified version of your project's most recent Git commit hash
+- De-identified versions of the branches and tags associated with that commit hash
 
@@ -155,2 +173,7 @@ **NPM data**
 
+Optionally, use the
+[IBM Telemetry Js Config Generator](https://www.npmjs.com/package/@ibm/telemetry-js-config-generator)
+script to automatically generate the config file. Remember to verify that the generated output is
+correct before using the config file.
+
 ### 3. Install `@ibm/telemetry-js` dependency.
@@ -157,0 +180,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3960964

increased by0.04%

Number of lines in readme file

253

increased by10%

No dependency changes