Add missing telemetry and extra logging

Author: paulacamargo25

src/extension/common/application/debugSessionTelemetry.ts

@@ -41,17 +41,18 @@ class TelemetryTracker implements DebugAdapterTracker {
         this.sendTelemetry(EventName.DEBUG_SESSION_STOP);
     }
 
-    public onError?(_error: Error): void {
-        this.sendTelemetry(EventName.DEBUG_SESSION_ERROR);
+    public onError?(error: Error): void {
+        this.sendTelemetry(EventName.DEBUG_SESSION_ERROR, error);
     }
 
-    private sendTelemetry(eventName: EventName): void {
+    private sendTelemetry<P extends IEventNamePropertyMapping, E extends keyof P>(eventName: EventName, properties?: P[E]): void {
         if (eventName === EventName.DEBUG_SESSION_START) {
             this.timer.reset();
         }
         const telemetryProps = {
             trigger: this.trigger,
             console: this.console,
+            ...properties
         };
         sendTelemetryEvent(eventName as keyof IEventNamePropertyMapping, this.timer.elapsedTime, telemetryProps);
     }

src/extension/debugger/adapter/factory.ts

@@ -149,6 +149,7 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
     }
 
     private async showDeprecatedPythonMessage() {
+        sendTelemetryEvent(EventName.DEBUGGER_PYTHON_37_DEPRECATED);
         const notificationPromptEnabled = this.persistentState.createGlobalPersistentState(
             debugStateKeys.doNotShowAgain,
             false,

src/extension/debugger/configuration/dynamicdebugConfigurationService.ts

@@ -10,6 +10,8 @@ import { IDynamicDebugConfigurationService } from '../types';
 import { DebuggerTypeName } from '../../constants';
 import { replaceAll } from '../../common/stringUtils';
 import { getDjangoPaths, getFastApiPaths, getFlaskPaths } from './utils/configuration';
+import { sendTelemetryEvent } from '../../telemetry';
+import { EventName } from '../../telemetry/constants';
 
 const workspaceFolderToken = '${workspaceFolder}';
 
@@ -20,7 +22,7 @@ export class DynamicPythonDebugConfigurationService implements IDynamicDebugConf
         _token?: CancellationToken,
     ): Promise<DebugConfiguration[] | undefined> {
         const providers = [];
-
+        
         providers.push({
             name: 'Python Debugger: Python File',
             type: DebuggerTypeName,
@@ -74,6 +76,8 @@ export class DynamicPythonDebugConfigurationService implements IDynamicDebugConf
             });
         }
 
+        sendTelemetryEvent(EventName.DEBUGGER_DYNAMIC_CONFIGURATION, undefined, { providers: providers });
+
         return providers;
     }
 }

src/extension/debugger/hooks/childProcessAttachService.ts

@@ -10,6 +10,7 @@ import { AttachRequestArguments } from '../../types';
 import { IChildProcessAttachService } from './types';
 import { getWorkspaceFolders, showErrorMessage } from '../../common/vscodeapi';
 import { noop } from '../../common/utils/misc';
+import { traceLog } from '../../common/log/logging';
 
 /**
  * This class is responsible for attaching the debugger to any
@@ -27,6 +28,7 @@ export class ChildProcessAttachService implements IChildProcessAttachService {
             lifecycleManagedByParent: true,
         };
         const folder = this.getRelatedWorkspaceFolder(debugConfig);
+        traceLog("Start debugger in the child proccess");
         const launched = await debug.startDebugging(folder, debugConfig, debugSessionOption);
         if (!launched) {
             showErrorMessage(l10n.t('Failed to launch debugger for child process {0}', debugConfig.subProcessId!)).then(

src/extension/debugger/hooks/debugpySocketsHandler.ts

@@ -10,6 +10,7 @@ import { DebuggerEvents } from './constants';
 import { DebuggerTypeName } from '../../constants';
 import { DebugPortAttributesProvider } from '../debugPort/portAttributesProvider';
 import { IDebugSessionEventHandlers } from './types';
+import { traceLog } from '../../common/log/logging';
 
 /**
  * This class is responsible for register ports using by debugpy in the portProvider.
@@ -30,6 +31,7 @@ export class DebugpySocketsHandler implements IDebugSessionEventHandlers {
         }
 
         if (event.event === DebuggerEvents.DebugpySockets) {
+            traceLog();
             let portSocket = event.body.sockets.find((socket: { [x: string]: any }) => {
                 return socket['internal'] === false;
             });

src/extension/extensionInit.ts

@@ -49,6 +49,7 @@ import { openReportIssue } from './common/application/commands/reportIssueComman
 import { buildApi } from './api';
 import { IExtensionApi } from './apiTypes';
 import { registerHexDebugVisualizationTreeProvider } from './debugger/visualizers/inlineHexDecoder';
+import { traceLog } from './common/log/logging';
 
 export async function registerDebugger(context: IExtensionContext): Promise<IExtensionApi> {
     const childProcessAttachService = new ChildProcessAttachService();
@@ -89,12 +90,14 @@ export async function registerDebugger(context: IExtensionContext): Promise<IExt
                 return;
             }
             const config = await getDebugConfiguration(file);
+            traceLog("Debugging using the editor button 'Debug in terminal'");
             startDebugging(undefined, config);
         }),
     );
 
     context.subscriptions.push(
         registerCommand(Commands.Debug_Using_Launch_Config, async (file?: Uri) => {
+            traceLog("Debugging using the editor button 'Debug using the launch.json'");
             sendTelemetryEvent(EventName.DEBUG_USING_LAUNCH_CONFIG_BUTTON);
             const interpreter = await getInterpreterDetails(file);
 

src/extension/telemetry/constants.ts

@@ -13,11 +13,14 @@ export enum EventName {
     DEBUG_SESSION_START = 'DEBUG_SESSION.START',
     DEBUG_SESSION_STOP = 'DEBUG_SESSION.STOP',
     DEBUG_SESSION_USER_CODE_RUNNING = 'DEBUG_SESSION.USER_CODE_RUNNING',
+    DEBUG_SHOW_INLINE_HEX_VALUE = 'DEBUG.SHOW_INLINE_HEX_VALUE',
     DEBUGGER = 'DEBUGGER',
     DEBUGGER_ATTACH_TO_CHILD_PROCESS = 'DEBUGGER.ATTACH_TO_CHILD_PROCESS',
     DEBUGGER_ATTACH_TO_LOCAL_PROCESS = 'DEBUGGER.ATTACH_TO_LOCAL_PROCESS',
     DEBUGGER_CONFIGURATION_PROMPTS = 'DEBUGGER.CONFIGURATION.PROMPTS',
     DEBUGGER_CONFIGURATION_PROMPTS_IN_LAUNCH_JSON = 'DEBUGGER.CONFIGURATION.PROMPTS.IN.LAUNCH.JSON',
+    DEBUGGER_DYNAMIC_CONFIGURATION = 'DEBUGGER.DYNAMIC_CONFIGURATION',
     ENVFILE_VARIABLE_SUBSTITUTION = 'ENVFILE_VARIABLE_SUBSTITUTION',
     USE_REPORT_ISSUE_COMMAND = 'USE_REPORT_ISSUE_COMMAND',
+    DEBUGGER_PYTHON_37_DEPRECATED = "DEBUGGER_PYTHON_37_DEPRECATED",
 }

src/extension/telemetry/index.ts

@@ -11,6 +11,7 @@ import { DebugConfigurationType } from '../debugger/types';
 import { EventName } from './constants';
 import { isPromise } from '../common/utils/async';
 import { getTelemetryReporter } from './reporter';
+import { DebugConfiguration } from 'vscode';
 
 /**
  * Checks whether telemetry is supported.
@@ -346,6 +347,7 @@ export interface IEventNamePropertyMapping {
          * @type {ConsoleType}
          */
         console?: ConsoleType;
+        error?: Error
     };
     /**
      * Telemetry captured after stopping debug session.
@@ -660,4 +662,25 @@ export interface IEventNamePropertyMapping {
       "use_report_issue_command" : { "owner": "paulacamargo25" }
      */
     [EventName.USE_REPORT_ISSUE_COMMAND]: unknown;
+    /** 
+     * Telemetry event sent when providing dynamic configuration for debugger
+     */
+    /* __GDPR__
+       "debugger_dynamic_config" : { "owner": "paulacamargo25" }
+     */
+    [EventName.DEBUGGER_DYNAMIC_CONFIGURATION]: {
+        /**
+        * Providers of dynamic configurations
+        * 
+        * @type {DebugConfiguration[]}
+        */
+        providers: DebugConfiguration[]
+    },
+    /**
+     * Telemetry event sent when the debugger is running with a non supports python versions minor than 3.7.
+     */
+    /* __GDPR__
+       "DEBUGGER_PYTHON_37_DEPRECATED" : { "owner": "paulacamargo25" }
+     */
+    [EventName.DEBUGGER_PYTHON_37_DEPRECATED]: never | undefined;
 }