Skip to content

Commit e661271

Browse files
Dev/ianhu/telemetry on shift enter (#4637)
Add telemetry for the shift enter command
1 parent a12316c commit e661271

File tree

4 files changed

+11
-2
lines changed

4 files changed

+11
-2
lines changed

news/2 Fixes/4636.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Provide telemetry for when we show the shift-enter banner and if the user clicks yes

src/client/datascience/constants.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,10 @@ export enum Telemetry {
103103
SubmitCellThroughInput = 'DATASCIENCE.SUBMITCELLFROMREPL',
104104
ConnectLocalJupyter = 'DATASCIENCE.CONNECTLOCALJUPYTER',
105105
ConnectRemoteJupyter = 'DATASCIENCE.CONNECTREMOTEJUPYTER',
106-
ConnectFailedJupyter = 'DATASCIENCE.CONNECTFAILEDJUPYTER'
107-
}
106+
ConnectFailedJupyter = 'DATASCIENCE.CONNECTFAILEDJUPYTER',
107+
ShiftEnterBannerShown = 'DATASCIENCE.SHIFTENTER_BANNER_SHOWN',
108+
EnableInteractiveShiftEnter = 'DATASCIENCE.ENABLE_INTERACTIVE_SHIFT_ENTER'
109+
}
108110

109111
export namespace HelpLinks {
110112
export const PythonInteractiveHelpLink = 'https://aka.ms/pyaiinstall';

src/client/datascience/shiftEnterBanner.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import '../common/extensions';
1010
import { IConfigurationService, IPersistentStateFactory,
1111
IPythonExtensionBanner } from '../common/types';
1212
import * as localize from '../common/utils/localize';
13+
import { captureTelemetry, sendTelemetryEvent } from '../telemetry';
14+
import { Telemetry } from './constants';
1315
import { IJupyterExecution } from './types';
1416

1517
export enum InteractiveShiftEnterStateKeys {
@@ -71,6 +73,7 @@ export class InteractiveShiftEnterBanner implements IPythonExtensionBanner {
7173
return;
7274
}
7375

76+
sendTelemetryEvent(Telemetry.ShiftEnterBannerShown);
7477
const response = await this.appShell.showInformationMessage(this.bannerMessage, ...this.bannerLabels);
7578
switch (response) {
7679
case this.bannerLabels[InteractiveShiftEnterLabelIndex.Yes]: {
@@ -98,6 +101,7 @@ export class InteractiveShiftEnterBanner implements IPythonExtensionBanner {
98101
await this.persistentState.createGlobalPersistentState<boolean>(InteractiveShiftEnterStateKeys.ShowBanner, false).updateValue(false);
99102
}
100103

104+
@captureTelemetry(Telemetry.EnableInteractiveShiftEnter)
101105
public async enableInteractiveShiftEnter(): Promise<void> {
102106
await this.configuration.updateSetting('dataScience.sendSelectionToInteractiveWindow', true, undefined, ConfigurationTarget.Global);
103107
await this.disable();

src/client/telemetry/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,7 @@ interface IEventNamePropertyMapping {
307307
[Telemetry.ConnectRemoteJupyter]: never | undefined;
308308
[Telemetry.DeleteAllCells]: never | undefined;
309309
[Telemetry.DeleteCell]: never | undefined;
310+
[Telemetry.EnableInteractiveShiftEnter]: never | undefined;
310311
[Telemetry.ExpandAll]: never | undefined;
311312
[Telemetry.ExportNotebook]: never | undefined;
312313
[Telemetry.ExportPythonFile]: never | undefined;
@@ -324,6 +325,7 @@ interface IEventNamePropertyMapping {
324325
[Telemetry.SelectJupyterURI]: never | undefined;
325326
[Telemetry.SetJupyterURIToLocal]: never | undefined;
326327
[Telemetry.SetJupyterURIToUserSpecified]: never | undefined;
328+
[Telemetry.ShiftEnterBannerShown]: never | undefined;
327329
[Telemetry.ShowHistoryPane]: never | undefined;
328330
[Telemetry.StartJupyter]: never | undefined;
329331
[Telemetry.SubmitCellThroughInput]: never | undefined;

0 commit comments

Comments
 (0)