From 401cf172d51fde2951db2eeac93e438172e76cd7 Mon Sep 17 00:00:00 2001 From: Kartik Raj Date: Tue, 27 Sep 2022 10:59:16 -0700 Subject: [PATCH 1/2] Do not send telemetry for `displayName` --- src/client/deprecatedProposedApi.ts | 1 - src/client/proposedApi.ts | 1 - src/client/telemetry/index.ts | 6 +----- 3 files changed, 1 insertion(+), 7 deletions(-) diff --git a/src/client/deprecatedProposedApi.ts b/src/client/deprecatedProposedApi.ts index ef4d8a1d5eaa..ea169447dd7e 100644 --- a/src/client/deprecatedProposedApi.ts +++ b/src/client/deprecatedProposedApi.ts @@ -72,7 +72,6 @@ export function buildDeprecatedProposedApi( sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, { apiName, extensionId: info.extensionId, - displayName: info.displayName, }), ) .ignoreErrors(); diff --git a/src/client/proposedApi.ts b/src/client/proposedApi.ts index 1147e839d0a5..ce7133e4e5b4 100644 --- a/src/client/proposedApi.ts +++ b/src/client/proposedApi.ts @@ -112,7 +112,6 @@ export function buildProposedApi( sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, { apiName, extensionId: info.extensionId, - displayName: info.displayName, }), ) .ignoreErrors(); diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts index 7211aa38e54f..1d1b2e076c13 100644 --- a/src/client/telemetry/index.ts +++ b/src/client/telemetry/index.ts @@ -1115,7 +1115,7 @@ export interface IEventNamePropertyMapping { /* __GDPR__ "python_environments_api" : { "extensionId" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": false , "owner": "karrtikr"}, - "displayName" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": false, "owner": "karrtikr" } + "apiName" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": false, "owner": "karrtikr" } } */ [EventName.PYTHON_ENVIRONMENTS_API]: { @@ -1123,10 +1123,6 @@ export interface IEventNamePropertyMapping { * The ID of the extension calling the API. */ extensionId: string; - /** - * The name of the extension as displayed in marketplace. - */ - displayName: string; /** * The name of the API called. */ From 944754ace77a3e023dfe5ad21b25c30f7b98664c Mon Sep 17 00:00:00 2001 From: Kartik Raj Date: Tue, 27 Sep 2022 11:01:40 -0700 Subject: [PATCH 2/2] Add logging as well --- src/client/deprecatedProposedApi.ts | 8 +++++--- src/client/proposedApi.ts | 9 +++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/src/client/deprecatedProposedApi.ts b/src/client/deprecatedProposedApi.ts index ea169447dd7e..c178c1f9f0a7 100644 --- a/src/client/deprecatedProposedApi.ts +++ b/src/client/deprecatedProposedApi.ts @@ -13,6 +13,7 @@ import { } from './deprecatedProposedApiTypes'; import { IInterpreterService } from './interpreter/contracts'; import { IServiceContainer } from './ioc/types'; +import { traceVerbose } from './logging'; import { PythonEnvInfo } from './pythonEnvironments/base/info'; import { getEnvPath } from './pythonEnvironments/base/info/env'; import { GetRefreshEnvironmentsOptions, IDiscoveryAPI } from './pythonEnvironments/base/locator'; @@ -68,12 +69,13 @@ export function buildDeprecatedProposedApi( } extensions .determineExtensionFromCallStack() - .then((info) => + .then((info) => { sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, { apiName, extensionId: info.extensionId, - }), - ) + }); + traceVerbose(`Extension ${info.extensionId} accessed ${apiName}`); + }) .ignoreErrors(); } diff --git a/src/client/proposedApi.ts b/src/client/proposedApi.ts index ce7133e4e5b4..543c1dfb426a 100644 --- a/src/client/proposedApi.ts +++ b/src/client/proposedApi.ts @@ -23,7 +23,7 @@ import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from './pythonEnvironment import { getEnvPath } from './pythonEnvironments/base/info/env'; import { IDiscoveryAPI } from './pythonEnvironments/base/locator'; import { IPythonExecutionFactory } from './common/process/types'; -import { traceError } from './logging'; +import { traceError, traceVerbose } from './logging'; import { normCasePath } from './common/platform/fs-paths'; import { sendTelemetryEvent } from './telemetry'; import { EventName } from './telemetry/constants'; @@ -108,12 +108,13 @@ export function buildProposedApi( function sendApiTelemetry(apiName: string) { extensions .determineExtensionFromCallStack() - .then((info) => + .then((info) => { sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, { apiName, extensionId: info.extensionId, - }), - ) + }); + traceVerbose(`Extension ${info.extensionId} accessed ${apiName}`); + }) .ignoreErrors(); } disposables.push(