Telemetry Compliance

Last updated at: August 14, 2024

CLI Telemetry Data

The Codemod CLI (v0.2.1 and later) collects anonymous usage data.

What is being collected?

Codemod CLI tracks events happening within the CLI and they have following properties (this is described in the CLI)

Property Name
Description
When tracked
Required by the VSCode's extension telemetry module
executionId
id of the codemod execution
passed if applicable
No
codemodName
name of the executed codemod
passed if applicable
No
fileCount
number of files processed by codemod
passed if applicable
No

We do not collect any metrics which may contain sensitive data.

This includes, but is not limited to: file system paths, contents of files, logs, or serialized JavaScript errors.

Opt-out telemetry

Users can disable telemetry by providing --no-telemetry flag to the CLI.

Example:

npx codemod react/19/replace-string-ref --no-telemetry

VSCode’s Extension Telemetry Data

The VSCode’s Extension (v0.25.0 and later) uses the VSCode’s TelemetryLogger, that guarantees that:

  • user settings to disable or tweak telemetry are respected, and that
  • potential sensitive data is removed

As Microsoft treats the GPDR and similar laws seriously (as outlined here), so do we.

We followed the extension guide on telemetry to ensure that we do not collect Personally-Identifiable Information (PII) and we send only the data we need for the continuous improvement of our product.

What is being collected?

The extension tracks the events happening within the extension and they have following properties (this is described in the extension’s source code):

Property Name
Description
When tracked
Required by the VSCode's extension telemetry module
executionId
id of the codemod execution
passed if applicable
No
codemodName
name of the executed codemod
passed if applicable
No
fileCount
number of files processed by codemod
passed if applicable
No
jobCount
number of jobs that were accepted or rejected
passed if applicable
No

We do not collect any metrics which may contain sensitive data.

This includes, but is not limited to: file system paths, contents of files, logs, or serialized JavaScript errors.

Note:

Users can review the telemetry events by using the VSCode’s Developer: Set Log Level... command and selecting the Trace log level. Then they should navigate to the Output Panel and pick Extension Telemetry from the dropdown to see the logs. You can read more here.

Opt-out telemetry

Users can disable telemetry by going into Settings, searching the for telemetry.telemetryLevel setting and setting it to off. You can read more here.