@inst/vscode-bin-darwin
Version:
BINARY ONLY - VSCode binary deployment for macOS
54 lines (42 loc) • 1.44 kB
Markdown
# vscode-extension-telemetry
This module provides a consistent way for first-party extensions to report telemetry
over Application Insights. The module respects the user's decision about whether or
not to send telemetry data.
# install
`npm install vscode-extension-telemetry`
# usage
```javascript
const vscode = require('vscode');
const TelemetryReporter = require('vscode-extension-telemetry');
// all events will be prefixed with this event name
const extensionId = '<your extension unique name>';
// extension version will be reported as a property with each event
const extensionVersion = '<your extension version>';
// the application insights key
const key = '<your key>';
// telemetry reporter
let reporter;
function activate(context: vscode.ExtensionContext) {
...
// create telemetry reporter on extension activation
reporter = new TelemetryReporter(extensionId, extensionVersion, key);
// ensure it gets property disposed
context.subscriptions.push(reporter);
...
}
...
// send event any time after activation
reporter.sendTelemetryEvent('sampleEvent', { 'stringProp': 'some string' }, { 'numericMeasure': 123});
```
# common properties
- `common.extname`
- `common.extversion`
- `common.vscodemachineid`
- `common.vscodesessionid`
- `common.vscodeversion`
- `common.os`
- `common.osversion`
- `common.sqmid`
- `common.sqmmachineid`
# License
[MIT](LICENSE)