Initial work to update telemetry to use Common Schema (#6203)

* Update admin-tool-ext-win to use new ads-extension-telemetry package * Add AdsTelemetryService for sending telemetry events using the ADS Common Schema * Clean up unused import and add engineType * Address PR comments * Update private var names
2026-02-16 18:46:40 -05:00 · 2019-06-30 19:38:04 +00:00
parent bc7ac519d0
commit 0503c8d8fe
10 changed files with 344 additions and 123 deletions
--- a/extensions/admin-tool-ext-win/package.json
+++ b/extensions/admin-tool-ext-win/package.json
@@ -70,7 +70,7 @@
 		]
 	},
 	"dependencies": {
-		"vscode-extension-telemetry": "^0.0.15",
+		"ads-extension-telemetry": "github:Charles-Gagnon/ads-extension-telemetry#0.1.0",
 		"vscode-nls": "^3.2.1"
 	},
 	"devDependencies": {
--- a/extensions/admin-tool-ext-win/src/main.ts
+++ b/extensions/admin-tool-ext-win/src/main.ts
@@ -7,7 +7,7 @@ import * as nls from 'vscode-nls';
 import * as path from 'path';
 import * as azdata from 'azdata';
 import * as vscode from 'vscode';
-import { Telemetry } from './telemetry';
+import { TelemetryReporter, TelemetryViews } from './telemetry';
 import { doubleEscapeSingleQuotes, backEscapeDoubleQuotes, getTelemetryErrorType } from './utils';
 import { ChildProcess, exec } from 'child_process';
 const localize = nls.loadMessageBundle();
@@ -95,7 +95,7 @@ function registerCommands(context: vscode.ExtensionContext): void {
 */
 async function handleLaunchSsmsMinPropertiesDialogCommand(connectionContext?: azdata.ObjectExplorerContext): Promise<void> {
 	if (!connectionContext) {
-		Telemetry.sendTelemetryEventForError('NoConnectionContext', { action: 'Properties' });
+		TelemetryReporter.sendErrorEvent(TelemetryViews.SsmsMinProperties, 'NoConnectionContext');
 		vscode.window.showErrorMessage(localize('adminToolExtWin.noConnectionContextForProp', 'No ConnectionContext provided for handleLaunchSsmsMinPropertiesDialogCommand'));
 		return;
 	}
@@ -107,7 +107,7 @@ async function handleLaunchSsmsMinPropertiesDialogCommand(connectionContext?: az
 	else if (connectionContext.nodeInfo) {
 		nodeType = connectionContext.nodeInfo.nodeType;
 	} else {
-		Telemetry.sendTelemetryEventForError('NoOENode', { action: 'Properties' });
+		TelemetryReporter.sendErrorEvent(TelemetryViews.SsmsMinProperties, 'NoOENode');
 		vscode.window.showErrorMessage(localize('adminToolExtWin.noOENode', 'Could not determine Object Explorer node from connectionContext : {0}', JSON.stringify(connectionContext)));
 		return;
 	}
@@ -124,7 +124,7 @@ async function handleLaunchSsmsMinPropertiesDialogCommand(connectionContext?: az
 async function handleLaunchSsmsMinGswDialogCommand(connectionContext?: azdata.ObjectExplorerContext): Promise<void> {
 	const action = 'GenerateScripts';
 	if (!connectionContext) {
-		Telemetry.sendTelemetryEventForError('NoConnectionContext', { action: action });
+		TelemetryReporter.sendErrorEvent(TelemetryViews.SsmsMinGsw, 'NoConnectionContext');
 		vscode.window.showErrorMessage(localize('adminToolExtWin.noConnectionContextForGsw', 'No ConnectionContext provided for handleLaunchSsmsMinPropertiesDialogCommand'));
 	}

@@ -141,7 +141,7 @@ async function handleLaunchSsmsMinGswDialogCommand(connectionContext?: azdata.Ob
 */
 async function launchSsmsDialog(action: string, connectionContext: azdata.ObjectExplorerContext): Promise<void> {
 	if (!connectionContext.connectionProfile) {
-		Telemetry.sendTelemetryEventForError('NoConnectionProfile', { action: action });
+		TelemetryReporter.sendErrorEvent(TelemetryViews.SsmsMinDialog, 'NoConnectionProfile');
 		vscode.window.showErrorMessage(localize('adminToolExtWin.noConnectionProfile', 'No connectionProfile provided from connectionContext : {0}', JSON.stringify(connectionContext)));
 		return;
 	}
@@ -155,7 +155,7 @@ async function launchSsmsDialog(action: string, connectionContext: azdata.Object
 		oeNode = await azdata.objectexplorer.getNode(connectionContext.connectionProfile.id, connectionContext.nodeInfo.nodePath);
 	}
 	else {
-		Telemetry.sendTelemetryEventForError('NoOENode', { action: action });
+		TelemetryReporter.sendErrorEvent(TelemetryViews.SsmsMinDialog, 'NoOENode');
 		vscode.window.showErrorMessage(localize('adminToolExtWin.noOENode', 'Could not determine Object Explorer node from connectionContext : {0}', JSON.stringify(connectionContext)));
 		return;
 	}
@@ -178,13 +178,15 @@ async function launchSsmsDialog(action: string, connectionContext: azdata.Object
 	};

 	const args = buildSsmsMinCommandArgs(params);
-
-	Telemetry.sendTelemetryEvent('LaunchSsmsDialog',
-		{
-			action: action,
-			nodeType: oeNode ? oeNode.nodeType : 'Server',
-			authType: connectionContext.connectionProfile.authenticationType
-		});
+	TelemetryReporter.createActionEvent(
+		TelemetryViews.SsmsMinDialog,
+		'LaunchSsmsDialog',
+		'',
+		action).withAdditionalProperties(
+			{
+				nodeType: oeNode ? oeNode.nodeType : 'Server'
+			}).withConnectionInfo(connectionContext.connectionProfile)
+		.send();

 	vscode.window.setStatusBarMessage(localize('adminToolExtWin.launchingDialogStatus', 'Launching dialog...'), 3000);

@@ -196,11 +198,14 @@ async function launchSsmsDialog(action: string, connectionContext: azdata.Object
 			// Process has exited so remove from map of running processes
 			runningProcesses.delete(proc.pid);
 			const err = stderr.toString();
-			Telemetry.sendTelemetryEvent('LaunchSsmsDialogResult', {
-				action: params.action,
-				returnCode: execException && execException.code ? execException.code.toString() : '0',
-				errorType: getTelemetryErrorType(err)
-			});
+			if ((execException && execException.code !== 0) || err !== '') {
+				TelemetryReporter.sendErrorEvent(
+					TelemetryViews.SsmsMinDialog,
+					'LaunchSsmsDialogError',
+					execException ? execException.code.toString() : '',
+					getTelemetryErrorType(err));
+			}
+
 			if (err !== '') {
 				vscode.window.showErrorMessage(localize(
 					'adminToolExtWin.ssmsMinError',
--- a/extensions/admin-tool-ext-win/src/telemetry.ts
+++ b/extensions/admin-tool-ext-win/src/telemetry.ts
@@ -4,99 +4,23 @@
 *--------------------------------------------------------------------------------------------*/

 'use strict';
-import * as vscode from 'vscode';
-import TelemetryReporter from 'vscode-extension-telemetry';
+import AdsTelemetryReporter from 'ads-extension-telemetry';

 import * as Utils from './utils';

 const packageJson = require('../package.json');

-export interface ITelemetryEventProperties {
-	[key: string]: string;
+let packageInfo = Utils.getPackageInfo(packageJson);
+
+export const TelemetryReporter = new AdsTelemetryReporter(packageInfo.name, packageInfo.version, packageInfo.aiKey);
+
+export enum TelemetryViews {
+	SsmsMinProperties = 'SsmsMinProperties',
+	SsmsMinGsw = 'SsmsMinGsw',
+	SsmsMinDialog = 'SsmsMinDialog'
 }

-export interface ITelemetryEventMeasures {
-	[key: string]: number;
-}

-/**
- * Filters error paths to only include source files. Exported to support testing
- */
-export function filterErrorPath(line: string): string {
-	if (line) {
-		let values: string[] = line.split('/out/');
-		if (values.length <= 1) {
-			// Didn't match expected format
-			return line;
-		} else {
-			return values[1];
-		}
-	}
-}

-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 = Utils.getPackageInfo(packageJson);
-			this.reporter = new TelemetryReporter(packageInfo.name, packageInfo.version, packageInfo.aiKey);
-		}
-	}
-
-	/**
-	 * Send a telemetry event for a general error
-	 * @param err The error to log
-	 */
-	public static sendTelemetryEventForError(err: string, properties?: ITelemetryEventProperties): void {
-		this.sendTelemetryEvent('Error', { error: err, ...properties });
-	}
-
-	/**
-	 * 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();
--- a/extensions/admin-tool-ext-win/yarn.lock
+++ b/extensions/admin-tool-ext-win/yarn.lock
@@ -2,6 +2,12 @@
 # yarn lockfile v1


+"ads-extension-telemetry@github:Charles-Gagnon/ads-extension-telemetry#0.1.0":
+  version "0.1.0"
+  resolved "https://codeload.github.com/Charles-Gagnon/ads-extension-telemetry/tar.gz/70c2fea10e9ff6e329c4c5ec0b77017ada514b6d"
+  dependencies:
+    vscode-extension-telemetry "0.1.1"
+
 ajv@^6.5.5:
  version "6.9.2"
  resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.9.2.tgz#4927adb83e7f48e5a32b45729744c71ec39c9c7b"
@@ -49,10 +55,10 @@ ansi-wrap@0.1.0:
  resolved "https://registry.yarnpkg.com/ansi-wrap/-/ansi-wrap-0.1.0.tgz#a82250ddb0015e9a27ca82e82ea603bbfa45efaf"
  integrity sha1-qCJQ3bABXponyoLoLqYDu/pF768=

-applicationinsights@1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/applicationinsights/-/applicationinsights-1.0.1.tgz#53446b830fe8d5d619eee2a278b31d3d25030927"
-  integrity sha1-U0Rrgw/o1dYZ7uKieLMdPSUDCSc=
+applicationinsights@1.0.8:
+  version "1.0.8"
+  resolved "https://registry.yarnpkg.com/applicationinsights/-/applicationinsights-1.0.8.tgz#db6e3d983cf9f9405fe1ee5ba30ac6e1914537b5"
+  integrity sha512-KzOOGdphOS/lXWMFZe5440LUdFbrLpMvh2SaRxn7BmiI550KAoSb2gIhiq6kJZ9Ir3AxRRztjhzif+e5P5IXIg==
  dependencies:
    diagnostic-channel "0.2.0"
    diagnostic-channel-publishers "0.2.1"
@@ -2271,12 +2277,12 @@ vinyl@~2.0.1:
    remove-trailing-separator "^1.0.1"
    replace-ext "^1.0.0"

-vscode-extension-telemetry@^0.0.15:
-  version "0.0.15"
-  resolved "https://registry.yarnpkg.com/vscode-extension-telemetry/-/vscode-extension-telemetry-0.0.15.tgz#685c32f3b67e8fb85ba689c1d7f88ff90ff87856"
-  integrity sha512-Yf6dL9r2x2GISI1xh22XsAaydSTQG/4aBitu8sGBwGr42n2TyOsIXGtXSDgqQBNZgYD6+P1EHqrrzetn9ekWTQ==
+vscode-extension-telemetry@0.1.1:
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/vscode-extension-telemetry/-/vscode-extension-telemetry-0.1.1.tgz#91387e06b33400c57abd48979b0e790415ae110b"
+  integrity sha512-TkKKG/B/J94DP5qf6xWB4YaqlhWDg6zbbqVx7Bz//stLQNnfE9XS1xm3f6fl24c5+bnEK0/wHgMgZYKIKxPeUA==
  dependencies:
-    applicationinsights "1.0.1"
+    applicationinsights "1.0.8"

 vscode-nls@^3.2.1:
  version "3.2.5"