vscode-extension-telemetry

constructor

constructor(
    extensionId: string,
    extensionVersion: string,
    key: string,
    firstParty?: boolean
);

• Parameter extensionId

  The id of your extension

  Parameter extensionVersion

  The version of your extension

  Parameter key

  The app insights key

  Parameter firstParty

  Whether or not the telemetry is first party (i.e from Microsoft / GitHub)

method dispose

dispose: () => Promise<any>;

method sendRawTelemetryEvent

sendRawTelemetryEvent: (
    eventName: string,
    properties?: RawTelemetryEventProperties,
    measurements?: TelemetryEventMeasurements
) => void;

• Sends a raw (unsanitized) telemetry event with the given properties and measurements

  Parameter eventName

  The name of the event

  Parameter properties

  The set of properties to add to the event in the form of a string key value pair

  Parameter measurements

  The set of measurements to add to the event in the form of a string key number value pair

method sendTelemetryErrorEvent

sendTelemetryErrorEvent: (
    eventName: string,
    properties?: TelemetryEventProperties,
    measurements?: TelemetryEventMeasurements,
    errorProps?: string[]
) => void;

• Sends a telemetry error event with the given properties, measurements, and errorProps

  Parameter eventName

  The name of the event

  Parameter properties

  The set of properties to add to the event in the form of a string key value pair

  Parameter measurements

  The set of measurements to add to the event in the form of a string key number value pair

  Parameter errorProps

  A list of case sensitive properties to drop, if excluded we drop all properties but still send the event

method sendTelemetryEvent

sendTelemetryEvent: (
    eventName: string,
    properties?: TelemetryEventProperties,
    measurements?: TelemetryEventMeasurements
) => void;

• Sends a telemetry event with the given properties and measurements Properties are sanitized on best-effort basis to remove sensitive data prior to sending.

  Parameter eventName

  The name of the event

  Parameter properties

  The set of properties to add to the event in the form of a string key value pair

  Parameter measurements

  The set of measurements to add to the event in the form of a string key number value pair

method sendTelemetryException

sendTelemetryException: (
    error: Error,
    properties?: TelemetryEventProperties,
    measurements?: TelemetryEventMeasurements
) => void;

• Sends an exception which includes the error stack, properties, and measurements

  Parameter error

  The error to send

  Parameter properties

  The set of properties to add to the event in the form of a string key value pair

  Parameter measurements

  The set of measurements to add to the event in the form of a string key number value pair

index signature

readonly [key: string]: any;

index signature

readonly [key: string]: number;

index signature

readonly [key: string]: string;