Extension telemetry feature cleanup (#21779)

* Extension telemetry feature cleanup

* one more

extensions/import/src/common/constants.ts

@@ -12,6 +12,7 @@ export const providerId = 'FlatFileImport';
 export const configLogDebugInfo = 'logDebugInfo';
 export const sqlConfigSectionName = 'sql';
 export const mssqlProvider = 'MSSQL';
+export const packageName = 'Microsoft.import';
 
 // allow-any-unicode-next-line
 export const summaryErrorSymbol = '✗ ';

extensions/import/src/main.ts

@@ -7,6 +7,7 @@ import * as vscode from 'vscode';
 
 import ControllerBase from './controllers/controllerBase';
 import MainController from './controllers/mainController';
+import { TelemetryReporter } from './services/telemetry';
 
 let controllers: ControllerBase[] = [];
 
@@ -18,6 +19,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
 	context.subscriptions.push(mainController);
 
 	await mainController.activate();
+	context.subscriptions.push(TelemetryReporter);
 }
 
 export function deactivate() {

extensions/import/src/services/contracts.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { RequestType, NotificationType } from 'vscode-languageclient';
+import * as telemetry from '@microsoft/ads-extension-telemetry';
 
 export interface IMessage {
 	jsonrpc: string;
@@ -24,19 +25,11 @@ export namespace TelemetryNotification {
 export class TelemetryParams {
 	public params: {
 		eventName: string;
-		properties: ITelemetryEventProperties;
-		measures: ITelemetryEventMeasures;
+		properties: telemetry.TelemetryEventProperties;
+		measures: telemetry.TelemetryEventMeasures;
 	};
 }
 
-export interface ITelemetryEventProperties {
-	[key: string]: string;
-}
-
-export interface ITelemetryEventMeasures {
-	[key: string]: number;
-}
-
 /**
  * Contract Classes
  */

extensions/import/src/services/features.ts

@@ -14,7 +14,7 @@ import {
 import * as UUID from 'vscode-languageclient/lib/utils/uuid';
 import { Disposable } from 'vscode';
 
-import { Telemetry } from './telemetry';
+import { TelemetryReporter } from './telemetry';
 import * as serviceUtils from './serviceUtils';
 import * as Contracts from './contracts';
 import { managerInstance, ApiType } from './serviceApiManager';
@@ -30,7 +30,7 @@ export class TelemetryFeature implements StaticFeature {
 
 	initialize(): void {
 		this._client.onNotification(Contracts.TelemetryNotification.type, e => {
-			Telemetry.sendTelemetryEvent(e.params.eventName, e.params.properties, e.params.measures);
+			TelemetryReporter.sendTelemetryEvent(e.params.eventName, e.params.properties, e.params.measures);
 		});
 	}
 }

extensions/import/src/services/serviceClient.ts

@@ -12,7 +12,7 @@ const localize = nls.loadMessageBundle();
 import * as path from 'path';
 import { EventAndListener } from 'eventemitter2';
 
-import { Telemetry, LanguageClientErrorHandler } from './telemetry';
+import { TelemetryReporter, LanguageClientErrorHandler } from './telemetry';
 import * as Constants from '../common/constants';
 import { TelemetryFeature, FlatFileImportFeature } from './features';
 import { promises as fs } from 'fs';
@@ -43,7 +43,7 @@ export class ServiceClient {
 				setTimeout(() => {
 					this.statusView.hide();
 				}, 1500);
-				Telemetry.sendTelemetryEvent('startup/LanguageClientStarted', {
+				TelemetryReporter.sendTelemetryEvent('startup/LanguageClientStarted', {
 					installationTime: String(installationComplete - installationStart),
 					processStartupTime: String(processEnd - processStart),
 					totalTime: String(processEnd - installationStart),
@@ -57,7 +57,7 @@ export class ServiceClient {
 			return client;
 		}
 		catch (error) {
-			Telemetry.sendTelemetryEvent('ServiceInitializingFailed');
+			TelemetryReporter.sendTelemetryEvent('ServiceInitializingFailed');
 			vscode.window.showErrorMessage(localize('flatFileImport.serviceStartFailed', "Failed to start {0}: {1}", Constants.serviceName, error));
 			// Just resolve to avoid unhandled promise. We show the error to the user.
 			return undefined;

extensions/import/src/services/telemetry.ts

@@ -4,12 +4,14 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { ErrorAction, CloseAction } from 'vscode-languageclient';
-import TelemetryReporter from '@microsoft/ads-extension-telemetry';
+import AdsTelemetryReporter from '@microsoft/ads-extension-telemetry';
 import * as vscode from 'vscode';
 
 import * as constants from '../common/constants';
-import { IMessage, ITelemetryEventProperties, ITelemetryEventMeasures } from './contracts';
+import { IMessage } from './contracts';
 
+const packageInfo = vscode.extensions.getExtension(constants.packageName)?.packageJSON;
+export const TelemetryReporter = new AdsTelemetryReporter<string, string>(packageInfo?.name, packageInfo?.version, packageInfo?.aiKey);
 
 /**
  * Handle Language Service client errors
@@ -29,8 +31,7 @@ export class LanguageClientErrorHandler {
 	 * @memberOf LanguageClientErrorHandler
 	 */
 	showOnErrorPrompt(): void {
-		// TODO add telemetry
-		// Telemetry.sendTelemetryEvent('SqlToolsServiceCrash');
+		TelemetryReporter.sendTelemetryEvent(constants.serviceName + 'Crash');
 		vscode.window.showErrorMessage(
 			constants.serviceCrashMessageText,
 			constants.crashButtonText
@@ -68,62 +69,3 @@ export class LanguageClientErrorHandler {
 	}
 }
 
-
-
-export class Telemetry {
-	private static reporter: TelemetryReporter;
-	private static disabled: boolean;
-
-	/**
-	 * Disable telemetry reporting
-	 */
-	public static disable(): void {
-		this.disabled = true;
-	}
-
-	/**
-	 * Initialize the telemetry reporter for use.
-	 */
-	public static initialize(): void {
-		if (typeof this.reporter === 'undefined') {
-			// Check if the user has opted out of telemetry
-			if (!vscode.workspace.getConfiguration('telemetry').get<boolean>('enableTelemetry', true)) {
-				this.disable();
-				return;
-			}
-			let packageInfo = vscode.extensions.getExtension('Microsoft.import').packageJSON;
-			this.reporter = new TelemetryReporter(packageInfo.name, packageInfo.version, packageInfo.aiKey);
-		}
-	}
-
-	/**
-	 * Send a telemetry event using application insights
-	 */
-	public static sendTelemetryEvent(
-		eventName: string,
-		properties?: ITelemetryEventProperties,
-		measures?: ITelemetryEventMeasures): void {
-
-		if (typeof this.disabled === 'undefined') {
-			this.disabled = false;
-		}
-
-		if (this.disabled || typeof (this.reporter) === 'undefined') {
-			// Don't do anything if telemetry is disabled
-			return;
-		}
-
-		if (!properties || typeof properties === 'undefined') {
-			properties = {};
-		}
-
-		try {
-			this.reporter.sendTelemetryEvent(eventName, properties, measures);
-		} catch (telemetryErr) {
-			// If sending telemetry event fails ignore it so it won't break the extension
-			console.error('Failed to send telemetry event. error: ' + telemetryErr);
-		}
-	}
-}
-
-Telemetry.initialize();