Add torch.profiler submodule telemetry (microsoft#15830)

joyceerhl · web-flow · commit b55a31a67bf4 · 2021-04-05T14:28:43.000-07:00
diff --git a/news/3 Code Health/15825.md b/news/3 Code Health/15825.md
@@ -0,0 +1 @@
+Add telemetry for identifying torch.profiler users.
diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts
@@ -135,6 +135,7 @@ export enum EventName {
     TENSORBOARD_INSTALL_PROMPT_SELECTION = 'TENSORBOARD.INSTALL_PROMPT_SELECTION',
     TENSORBOARD_DETECTED_IN_INTEGRATED_TERMINAL = 'TENSORBOARD_DETECTED_IN_INTEGRATED_TERMINAL',
     TENSORBOARD_PACKAGE_INSTALL_RESULT = 'TENSORBOARD.PACKAGE_INSTALL_RESULT',
+    TENSORBOARD_TORCH_PROFILER_IMPORT = 'TENSORBOARD.TORCH_PROFILER_IMPORT',
 }
 
 export enum PlatformErrors {
diff --git a/src/client/telemetry/importTracker.ts b/src/client/telemetry/importTracker.ts
@@ -14,6 +14,7 @@ import { isTestExecution } from '../common/constants';
 import '../common/extensions';
 import { IDisposableRegistry } from '../common/types';
 import { noop } from '../common/utils/misc';
+import { TorchProfilerImportRegEx } from '../tensorBoard/helpers';
 import { EventName } from './constants';
 
 /*
@@ -139,6 +140,9 @@ export class ImportTracker implements IExtensionSingleActivationService {
                         packageNames.forEach((p) => this.sendTelemetry(p));
                     }
                 }
+                if (s && TorchProfilerImportRegEx.test(s)) {
+                    sendTelemetryEvent(EventName.TENSORBOARD_TORCH_PROFILER_IMPORT);
+                }
             }
         } catch {
             // Don't care about failures since this is just telemetry.
diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
@@ -1816,4 +1816,11 @@ export interface IEventNamePropertyMapping {
         wasProfilerPluginInstalled: boolean;
         wasTensorBoardInstalled: boolean;
     };
+    /**
+     * Telemetry event sent when the user's files contain a PyTorch profiler module
+     * import. Files are checked for matching imports when they are opened or saved.
+     * Matches cover import statements of the form `import torch.profiler` and
+     * `from torch import profiler`.
+     */
+    [EventName.TENSORBOARD_TORCH_PROFILER_IMPORT]: never | undefined;
 }
diff --git a/src/client/tensorBoard/helpers.ts b/src/client/tensorBoard/helpers.ts
@@ -10,7 +10,7 @@ import { noop } from '../common/utils/misc';
 // matches the 'main' module.
 
 // RegEx to match `import torch.profiler` or `from torch import profiler`
-const TorchProfilerImportRegEx = /^\s*(?:import (?:(\w+, )*torch\.profiler(, \w+)*))|(?:from torch import (?:(\w+, )*profiler(, \w+)*))/;
+export const TorchProfilerImportRegEx = /^\s*(?:import (?:(\w+, )*torch\.profiler(, \w+)*))|(?:from torch import (?:(\w+, )*profiler(, \w+)*))/;
 // RegEx to match `from torch.utils import tensorboard`, `import torch.utils.tensorboard`, `import tensorboardX`, `import tensorboard`
 const TensorBoardImportRegEx = /^\s*(?:from torch\.utils\.tensorboard import \w+)|(?:from torch\.utils import (?:(\w+, )*tensorboard(, \w+)*))|(?:from tensorboardX import \w+)|(?:import (\w+, )*((torch\.utils\.tensorboard)|(tensorboardX)|(tensorboard))(, \w+)*)/;
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add telemetry for identifying torch.profiler users.`
Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,7 @@ export enum EventName {`
`135`	`135`	`TENSORBOARD_INSTALL_PROMPT_SELECTION = 'TENSORBOARD.INSTALL_PROMPT_SELECTION',`
`136`	`136`	`TENSORBOARD_DETECTED_IN_INTEGRATED_TERMINAL = 'TENSORBOARD_DETECTED_IN_INTEGRATED_TERMINAL',`
`137`	`137`	`TENSORBOARD_PACKAGE_INSTALL_RESULT = 'TENSORBOARD.PACKAGE_INSTALL_RESULT',`
	`138`	`+ TENSORBOARD_TORCH_PROFILER_IMPORT = 'TENSORBOARD.TORCH_PROFILER_IMPORT',`
`138`	`139`	`}`
`139`	`140`
`140`	`141`	`export enum PlatformErrors {`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ import { isTestExecution } from '../common/constants';`
`14`	`14`	`import '../common/extensions';`
`15`	`15`	`import { IDisposableRegistry } from '../common/types';`
`16`	`16`	`import { noop } from '../common/utils/misc';`
	`17`	`+import { TorchProfilerImportRegEx } from '../tensorBoard/helpers';`
`17`	`18`	`import { EventName } from './constants';`
`18`	`19`
`19`	`20`	`/*`
`@@ -139,6 +140,9 @@ export class ImportTracker implements IExtensionSingleActivationService {`
`139`	`140`	`packageNames.forEach((p) => this.sendTelemetry(p));`
`140`	`141`	`}`
`141`	`142`	`}`
	`143`	`+ if (s && TorchProfilerImportRegEx.test(s)) {`
	`144`	`+ sendTelemetryEvent(EventName.TENSORBOARD_TORCH_PROFILER_IMPORT);`
	`145`	`+ }`
`142`	`146`	`}`
`143`	`147`	`} catch {`
`144`	`148`	`// Don't care about failures since this is just telemetry.`