microsoft / vscode-extension-telemetry

Node module to help VS Code extensions send telemetry using application insights
https://www.npmjs.com/package/@vscode/extension-telemetry
Other
125 stars 46 forks source link

Clarify what events/traces/metrics are collected by default #173

Open baywet opened 1 year ago

baywet commented 1 year ago

Hi 👋 We're exploring this package to instrumentalize our vscode extension.

One thing that's not clear from the documentation/readme is what is collected by default. If the documentation tells us which properties are added to "manually" logged events, it doesn't tell us much else.

It'd be good to answer questions like:

lramos15 commented 1 year ago

Yeah the documentation can definitely be improved here. All this module provides is leveraging the VS Code API in both web and node environments using Microsoft telemetry systems such as App Insights and 1DS. It's goal is to be an easy starting point to add whatever events an extension feels comfortable with from a privacy perspective while respecting all the requirements we ask of VS Code Extension developers.

The only things that are collected for you are uncaught exceptions (exceptions, not crashes) and some common properties we find can be helpful https://github.com/microsoft/vscode/blob/cd1af5b0601470fbe9d58abe861485c9fdceee3b/src/vs/workbench/api/common/extHostTelemetry.ts#L98-L124