Merge pull request #236 from microsoft/vijayu/updateDist

Update dist file

Author: vijayupadya

README.md

@@ -69,7 +69,7 @@ reporter.sendTelemetryErrorEvent(
 );
 ```
 
-# Advanced Features (v1.3.0+)
+# Advanced Features (v1.4.0+)
 
 ## Custom Endpoints and Configuration
 

dist/telemetryReporter.d.ts

@@ -26,6 +26,31 @@ export interface ReplacementOption {
 	replacementString?: string;
 }
 
+/**
+ * Options for configuring Application Insights client with custom behavior.
+ * Allows customization of endpoint URLs, common properties, and tag overrides.
+ */
+export interface AppInsightsClientOptions {
+	/**
+	 * Custom endpoint URL for Application Insights telemetry data.
+	 * Use this to send telemetry to a different ingestion endpoint.
+	 */
+	endpointUrl?: string;
+
+	/**
+	 * Common properties to be added to all telemetry events.
+	 * These properties will be merged into every event sent by the client.
+	 */
+	commonProperties?: Record<string, string>;
+
+	/**
+	 * Tag overrides to customize Application Insights context tags.
+	 * Maps to the 'ext' object in Application Insights Web Basic SDK.
+	 * Common use case: overriding tracking IDs or session identifiers.
+	 */
+	tagOverrides?: Record<string, string>;
+}
+
 /**
  * A custom fetcher function that can be used to send telemetry data.
  * Compatible with the Node.js fetch API signature.
@@ -44,8 +69,9 @@ export class TelemetryReporter {
 	 * @param replacementOptions A list of replacement options for the app insights client. This allows the sender to filter out any sensitive or unnecessary information from the telemetry server.
 	 * @param initializationOptions Options for configuring the telemetry reporter, including additional common properties to be sent with each event.
 	 * @param customFetcher An optional custom fetcher function to use for sending telemetry data. If not provided, the default HTTPS module will be used. Compatible with Node.js fetch API.
+	 * @param appInsightsOptions Optional Application Insights client configuration for custom endpoint URLs, common properties, and tag overrides.
 	 */
-	constructor(connectionString: string, replacementOptions?: ReplacementOption[], initializationOptions?: import("vscode").TelemetryLoggerOptions, customFetcher?: CustomFetcher);
+	constructor(connectionString: string, replacementOptions?: ReplacementOption[], initializationOptions?: import("vscode").TelemetryLoggerOptions, customFetcher?: CustomFetcher, appInsightsOptions?: AppInsightsClientOptions);
 
 	/**
 	 * A string representation of the current level of telemetry being collected
@@ -57,23 +83,40 @@ export class TelemetryReporter {
 	 */
 	onDidChangeTelemetryLevel: import("vscode").Event<'all' | 'error' | 'crash' | 'off'>;
 
+	/**
+	 * Sets a context tag that will be included in all telemetry events.
+	 * Similar to client.context.tags[key] = value in the full Application Insights SDK.
+	 * @param key The tag key (e.g., 'ai.cloud.roleInstance', 'ai.session.id')
+	 * @param value The tag value
+	 */
+	setContextTag(key: string, value: string): void;
+
+	/**
+	 * Gets a context tag value.
+	 * @param key The tag key to retrieve
+	 * @returns The tag value, or undefined if not set
+	 */
+	getContextTag(key: string): string | undefined;
+
 	/**
 	 * Sends a telemetry event with the given properties and measurements
 	 * Properties are sanitized on best-effort basis to remove sensitive data prior to sending.
 	 * @param eventName The name of the event
 	 * @param properties The set of properties to add to the event in the form of a string key value pair
 	 * @param measurements The set of measurements to add to the event in the form of a string key  number value pair
+	 * @param tagOverrides Optional per-event tag overrides (e.g., dynamic tracking IDs). Takes precedence over context tags.
 	 */
-	sendTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements, tagOverrides?: Record<string, string>): void;
 
 	/**
 	 * Sends a raw (unsanitized) telemetry event with the given properties and measurements
 	 * NOTE: This will not be logged to the output channel due to API limitations.
 	 * @param eventName The name of the event
 	 * @param properties The set of properties to add to the event in the form of a string key value pair
 	 * @param measurements The set of measurements to add to the event in the form of a string key  number value pair
+	 * @param tagOverrides Optional per-event tag overrides (e.g., dynamic tracking IDs). Takes precedence over context tags.
 	 */
-	sendRawTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendRawTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements, tagOverrides?: Record<string, string>): void;
 
 	/**
 	 * **DANGEROUS** Given an event name, some properties, and measurements sends a telemetry event without checking telemetry setting
@@ -82,17 +125,19 @@ export class TelemetryReporter {
 	 * @param eventName The name of the event
 	 * @param properties The properties to send with the event
 	 * @param measurements The measurements (numeric values) to send with the event
+	 * @param tagOverrides Optional per-event tag overrides (e.g., dynamic tracking IDs). Takes precedence over context tags.
 	 */
-	sendDangerousTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendDangerousTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements, tagOverrides?: Record<string, string>): void;
 
 	/**
 	 * Sends a telemetry error event with the given properties, measurements.
 	 * **Note**: The errorProps parameter has been removed since v0.6, if you would like to remove a property please use the replacementOptions parameter in the constructor.
 	 * @param eventName The name of the event
 	 * @param properties The set of properties to add to the event in the form of a string key value pair
 	 * @param measurements The set of measurements to add to the event in the form of a string key  number value pair
+	 * @param tagOverrides Optional per-event tag overrides (e.g., dynamic tracking IDs). Takes precedence over context tags.
 	 */
-	sendTelemetryErrorEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendTelemetryErrorEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements, tagOverrides?: Record<string, string>): void;
 
 	/**
 	 * **DANGEROUS** Given an event name, some properties, and measurements sends a telemetry error event without checking telemetry setting
@@ -101,8 +146,9 @@ export class TelemetryReporter {
 	 * @param eventName The name of the event
 	 * @param properties The properties to send with the event
 	 * @param measurements The measurements (numeric values) to send with the event
+	 * @param tagOverrides Optional per-event tag overrides (e.g., dynamic tracking IDs). Takes precedence over context tags.
 	 */
-	sendDangerousTelemetryErrorEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendDangerousTelemetryErrorEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements, tagOverrides?: Record<string, string>): void;
 
 	/**
 	 * Disposes of the telemetry reporter. This flushes the remaining events and disposes of the telemetry client.

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@vscode/extension-telemetry",
   "description": "A module for Visual Studio Code extensions to report consistent telemetry.",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "author": {
     "name": "Microsoft Corporation"
   },