Merge pull request microsoft#61356 from Microsoft/telemetry-add-breakpoints

isidorn · web-flow · commit 8cf7bee0ac39 · 2018-10-23T12:05:26.000+02:00
Add telemetry for debug add breakpoints microsoft#55514
diff --git a/src/vs/workbench/api/electron-browser/mainThreadDebugService.ts b/src/vs/workbench/api/electron-browser/mainThreadDebugService.ts
@@ -133,7 +133,7 @@ export class MainThreadDebugService implements MainThreadDebugServiceShape, IDeb
 						logMessage: l.logMessage
 					}
 				);
-				this.debugService.addBreakpoints(uri.revive(dto.uri), rawbps);
+				this.debugService.addBreakpoints(uri.revive(dto.uri), rawbps, 'extension');
 			} else if (dto.type === 'function') {
 				this.debugService.addFunctionBreakpoint(dto.functionName, dto.id);
 			}
diff --git a/src/vs/workbench/parts/debug/browser/debugCommands.ts b/src/vs/workbench/parts/debug/browser/debugCommands.ts
@@ -211,7 +211,7 @@ export function registerCommands(): void {
 				return Promise.resolve(null);
 			}
 			if (debugService.getConfigurationManager().canSetBreakpointsIn(widget.getModel())) {
-				return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber, column: position.column > 1 ? position.column : undefined }]);
+				return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber, column: position.column > 1 ? position.column : undefined }], 'debugCommands.inlineBreakpointCommand');
 			}
 		}
 
diff --git a/src/vs/workbench/parts/debug/browser/debugEditorActions.ts b/src/vs/workbench/parts/debug/browser/debugEditorActions.ts
@@ -45,7 +45,7 @@ class ToggleBreakpointAction extends EditorAction {
 			return Promise.all(bps.map(bp => debugService.removeBreakpoints(bp.getId())));
 		}
 		if (debugService.getConfigurationManager().canSetBreakpointsIn(editor.getModel())) {
-			return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber }]);
+			return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber }], 'debugEditorActions.toggleBreakpointAction');
 		}
 
 		return Promise.resolve(null);
@@ -130,7 +130,7 @@ class RunToCursorAction extends EditorAction {
 		const position = editor.getPosition();
 		const uri = editor.getModel().uri;
 		const bpExists = !!(debugService.getModel().getBreakpoints({ column: position.column, lineNumber: position.lineNumber, uri }).length);
-		return (bpExists ? Promise.resolve(null) : <Promise<any>>debugService.addBreakpoints(uri, [{ lineNumber: position.lineNumber, column: position.column }])).then((breakpoints) => {
+		return (bpExists ? Promise.resolve(null) : <Promise<any>>debugService.addBreakpoints(uri, [{ lineNumber: position.lineNumber, column: position.column }], 'debugEditorActions.runToCursorAction')).then((breakpoints) => {
 			if (breakpoints && breakpoints.length) {
 				breakpointToRemove = breakpoints[0];
 			}
diff --git a/src/vs/workbench/parts/debug/common/debug.ts b/src/vs/workbench/parts/debug/common/debug.ts
@@ -676,7 +676,7 @@ export interface IDebugService {
 	/**
 	 * Adds new breakpoints to the model for the file specified with the uri. Notifies debug adapter of breakpoint changes.
 	 */
-	addBreakpoints(uri: uri, rawBreakpoints: IBreakpointData[]): TPromise<IBreakpoint[]>;
+	addBreakpoints(uri: uri, rawBreakpoints: IBreakpointData[], context: string): TPromise<IBreakpoint[]>;
 
 	/**
 	 * Updates the breakpoints.
diff --git a/src/vs/workbench/parts/debug/electron-browser/breakpointWidget.ts b/src/vs/workbench/parts/debug/electron-browser/breakpointWidget.ts
@@ -183,7 +183,7 @@ export class BreakpointWidget extends ZoneWidget implements IPrivateBreakpointWi
 					condition,
 					hitCondition,
 					logMessage
-				}]);
+				}], `breakpointWidget`);
 			}
 		}
 
diff --git a/src/vs/workbench/parts/debug/electron-browser/debugEditorContribution.ts b/src/vs/workbench/parts/debug/electron-browser/debugEditorContribution.ts
@@ -148,7 +148,7 @@ export class DebugEditorContribution implements IDebugEditorContribution {
 				nls.localize('addBreakpoint', "Add Breakpoint"),
 				null,
 				true,
-				() => this.debugService.addBreakpoints(uri, [{ lineNumber }])
+				() => this.debugService.addBreakpoints(uri, [{ lineNumber }], `debugEditorContextMenu`)
 			));
 			actions.push(new Action(
 				'addConditionalBreakpoint',
@@ -230,7 +230,7 @@ export class DebugEditorContribution implements IDebugEditorContribution {
 						breakpoints.forEach(bp => this.debugService.removeBreakpoints(bp.getId()));
 					}
 				} else if (canSetBreakpoints) {
-					this.debugService.addBreakpoints(uri, [{ lineNumber }]);
+					this.debugService.addBreakpoints(uri, [{ lineNumber }], `debugEditorGutter`);
 				}
 			}
 		}));
diff --git a/src/vs/workbench/parts/debug/electron-browser/debugService.ts b/src/vs/workbench/parts/debug/electron-browser/debugService.ts
@@ -822,9 +822,10 @@ export class DebugService implements IDebugService {
 		return this.sendAllBreakpoints();
 	}
 
-	addBreakpoints(uri: uri, rawBreakpoints: IBreakpointData[]): TPromise<IBreakpoint[]> {
+	addBreakpoints(uri: uri, rawBreakpoints: IBreakpointData[], context: string): TPromise<IBreakpoint[]> {
 		const breakpoints = this.model.addBreakpoints(uri, rawBreakpoints);
 		breakpoints.forEach(bp => aria.status(nls.localize('breakpointAdded', "Added breakpoint, line {0}, file {1}", bp.lineNumber, uri.fsPath)));
+		breakpoints.forEach(bp => this.telemetryDebugAddBreakpoint(bp, context));
 
 		return this.sendBreakpoints(uri).then(() => breakpoints);
 	}
@@ -1064,4 +1065,22 @@ export class DebugService implements IDebugService {
 			error: message
 		});
 	}
+
+	private telemetryDebugAddBreakpoint(breakpoint: IBreakpoint, context: string): TPromise<any> {
+		/* __GDPR__
+			"debugAddBreakpoint" : {
+				"context": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+				"hasCondition": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+				"hasHitCondition": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+				"hasLogMessage": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+			}
+		*/
+
+		return this.telemetryService.publicLog('debugAddBreakpoint', {
+			context: context,
+			hasCondition: !!breakpoint.condition,
+			hasHitCondition: !!breakpoint.hitCondition,
+			hasLogMessage: !!breakpoint.logMessage
+		});
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ export class MainThreadDebugService implements MainThreadDebugServiceShape, IDeb`
`133`	`133`	`logMessage: l.logMessage`
`134`	`134`	`}`
`135`	`135`	`);`
`136`		`- this.debugService.addBreakpoints(uri.revive(dto.uri), rawbps);`
	`136`	`+ this.debugService.addBreakpoints(uri.revive(dto.uri), rawbps, 'extension');`
`137`	`137`	`} else if (dto.type === 'function') {`
`138`	`138`	`this.debugService.addFunctionBreakpoint(dto.functionName, dto.id);`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ export function registerCommands(): void {`
`211`	`211`	`return Promise.resolve(null);`
`212`	`212`	`}`
`213`	`213`	`if (debugService.getConfigurationManager().canSetBreakpointsIn(widget.getModel())) {`
`214`		`- return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber, column: position.column > 1 ? position.column : undefined }]);`
	`214`	`+ return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber, column: position.column > 1 ? position.column : undefined }], 'debugCommands.inlineBreakpointCommand');`
`215`	`215`	`}`
`216`	`216`	`}`
`217`	`217`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class ToggleBreakpointAction extends EditorAction {`
`45`	`45`	`return Promise.all(bps.map(bp => debugService.removeBreakpoints(bp.getId())));`
`46`	`46`	`}`
`47`	`47`	`if (debugService.getConfigurationManager().canSetBreakpointsIn(editor.getModel())) {`
`48`		`- return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber }]);`
	`48`	`+ return debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber }], 'debugEditorActions.toggleBreakpointAction');`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`return Promise.resolve(null);`
`@@ -130,7 +130,7 @@ class RunToCursorAction extends EditorAction {`
`130`	`130`	`const position = editor.getPosition();`
`131`	`131`	`const uri = editor.getModel().uri;`
`132`	`132`	`const bpExists = !!(debugService.getModel().getBreakpoints({ column: position.column, lineNumber: position.lineNumber, uri }).length);`
`133`		`- return (bpExists ? Promise.resolve(null) : <Promise<any>>debugService.addBreakpoints(uri, [{ lineNumber: position.lineNumber, column: position.column }])).then((breakpoints) => {`
	`133`	`+ return (bpExists ? Promise.resolve(null) : <Promise<any>>debugService.addBreakpoints(uri, [{ lineNumber: position.lineNumber, column: position.column }], 'debugEditorActions.runToCursorAction')).then((breakpoints) => {`
`134`	`134`	`if (breakpoints && breakpoints.length) {`
`135`	`135`	`breakpointToRemove = breakpoints[0];`
`136`	`136`	`}`
Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ export class BreakpointWidget extends ZoneWidget implements IPrivateBreakpointWi`
`183`	`183`	`condition,`
`184`	`184`	`hitCondition,`
`185`	`185`	`logMessage`
`186`		`- }]);`
	`186`	+ }], `breakpointWidget`);
`187`	`187`	`}`
`188`	`188`	`}`
`189`	`189`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ export class DebugEditorContribution implements IDebugEditorContribution {`
`148`	`148`	`nls.localize('addBreakpoint', "Add Breakpoint"),`
`149`	`149`	`null,`
`150`	`150`	`true,`
`151`		`- () => this.debugService.addBreakpoints(uri, [{ lineNumber }])`
	`151`	+ () => this.debugService.addBreakpoints(uri, [{ lineNumber }], `debugEditorContextMenu`)
`152`	`152`	`));`
`153`	`153`	`actions.push(new Action(`
`154`	`154`	`'addConditionalBreakpoint',`
`@@ -230,7 +230,7 @@ export class DebugEditorContribution implements IDebugEditorContribution {`
`230`	`230`	`breakpoints.forEach(bp => this.debugService.removeBreakpoints(bp.getId()));`
`231`	`231`	`}`
`232`	`232`	`} else if (canSetBreakpoints) {`
`233`		`- this.debugService.addBreakpoints(uri, [{ lineNumber }]);`
	`233`	+ this.debugService.addBreakpoints(uri, [{ lineNumber }], `debugEditorGutter`);
`234`	`234`	`}`
`235`	`235`	`}`
`236`	`236`	`}));`