vscode-extension-telemetry

Changes:

• #213: Bump version + packages
• #211: Update readme + support connection string
• #210: Send user id in extension paylod
• #207: Bump braces from 3.0.2 to 3.0.3
• #206: Update packages
• #204: Rollback packages

This list of changes was auto generated.

• Allows measurements to also be undefined for easy omitting, similar to how properties work

• Improves on the user agent metric shown when navigator.userAgentData is unavailable. Thanks to @sezna
• Fixes a bug with telemetry fetching using app insights on older version of node. Thanks to @devm33

This release contains a small fix to the 1DS package used by Microsoft extensions in the web to ensure compliance with the California's Global Privacy Control. If you're not a Microsoft extension, then it is safe to disregard this release as it contains no new features or improvements for the third party flow.

Thanks to a community contribution by @ilia-db the unhandlederror event handler has been properly fixed to include common properties.

Application insights web basics comes with the ability to pass in a fetch pollyfill that allows it to be used for both Node and Web. This is similar to what we already do for first party extensions using the 1DS package.

While there is no breaking changes here, the replacement of a key dependency with what should be an equivalent alternative may have unknown edge cases that were not accounted for, therefore the version has been bumped to reflect this.

Bundlephobia reports a 67Kb decline in bundle size with this change.

• Improves shutdown performance by lessening the amount of time which is allocated to disposing the telemetry reporters. Additionally, removes a few redundant flushes. Fixes https://github.com/microsoft/vscode/issues/192742

• Fixes a bug where if the user's connection were to drop during a session, telemetry would no longer send for the rest of that session
• Fixes a bug with sendRawTelemetryEvent sending key: key pairs instead of key: value pairs

• Fixes the sendRawTelemetryEvent function which was missing in the implementation, but defined in the .d.ts
• Updates word-wrap and semver to address Dependabot security violations

This release only contains bug fixes

• Fixes a bug where we would cause infinite error loops in the sendErrorData function https://github.com/microsoft/vscode-extension-telemetry/pull/158
• Fixes a bug where we would not properly wait for the telemetry buffer to flush https://github.com/microsoft/vscode-extension-telemetry/pull/155

Note: This release contains a breaking change to the typings.
The ability to log a raw Error object has been removed. You will now have to use sendTelemetryErrorEvent and break the error stack down into the properties you want due to the web app insights and 1DS library both not supporting this. We want the module to abstract the details away and offer a uniform experience across all platforms.

Also fixes a bug surrounding not logging events properly on shutdown.

Note: This breaks the .d.ts file in that it removes some extension specific information from the constructor in favor of just supplying the key.

This module will now directly consume the VS Code telemetry API announced with the release of 1.75.0. This API should vastly improve the telemetry experience.

New Features

• Automatic error handling logged to your sendTelemetryException function.
• A shared Extension Telemetry output channel that allows you to see and debug the flow of telemetry in product when log level is set to trace
• PII cleaning which is automatically updated with the version of VS Code
• Support for the new Error telemetry level rather than a simple on off switch.

Stops bundling the 1DS SDK due to issues with webpack. The hopes is to eventually stop bundling app insights as well as the weird bundling structure of mixing esbuild and webpack can cause issues for extensions.

Note: This release only addresses issues affecting 1st party extensions

• Adds support for 1DS SDK and Common Schema 4.0 with the deprecation of Common Schema 2.0
• Switches 1st party endpoints from vortex to collector++ (this allows for backwards compatibility of CS 2.0 so old extensions can still work)

Note: This release breaks the .d.ts by removing errorProps as a parameter option from sendTelemetryErrorEvent.

ErrorProps used to be used for certain environments that required special compliance. This parameter only affected first party extensions and led to a lot of confusion surrounding when errorProps applied. To help unify the first and third party experience the errorProps parameter has been removed.

• Fixes missing extensionID prefix when using any of the sendTelemetryErrorEvent functions
• Some community contributed README polish

Currently VS Code disables telemetry when developing an extension or running extension tests. In some cases one might want to send telemetry in these cases.

This releases adds a set of sendDangerous* functions which will send telemetry without checking the user setting. As described in the name these functions are dangerous and should only be used in controlled environments such as extension tests or during development.

Thanks to @aeisenberg we now support a set of replacement options which can be used for custom redaction.
The reporter will now check every event for the set of regular expressions and replace them with the defined replacement strings. As with anything regex related this has the opportunity to cause significant performance degradation due to inefficient regular expressions.

This change is backwards compatible with previous versions, but does introduce a new optional parameter to the TelemetryReporter in the form of a ReplacementOption list. The new typings can be found in the bundled .d.ts file.

Added more verbose error messages to help track down cases where the module fails to initialize or events fail to send.

• Previously errors were disabled on the web, but recent build changes within core VS Code and the extension have allowed us to now send error telemetry on the web. This release just serves to remove the safety guards previously preventing that.