Telemetry for debugging

Paul van Brenk · Paul van Brenk · commit 6f3cfa9db6a2 · 2017-05-23T11:28:57.000-07:00
diff --git a/Nodejs/Product/Nodejs/Debugger/NodeDebugProvider.cs b/Nodejs/Product/Nodejs/Debugger/NodeDebugProvider.cs
@@ -4,6 +4,7 @@
 using System.ComponentModel.Composition;
 using System.IO;
 using Microsoft.NodejsTools.Project;
+using Microsoft.NodejsTools.Telemetry;
 using Microsoft.VisualStudio.Setup.Configuration;
 using Microsoft.VisualStudio.Shell.Interop;
 using Microsoft.VisualStudio.Workspace;
@@ -47,16 +48,18 @@ internal class NodeJsDebugLaunchProvider : IVsDebugLaunchTargetProvider
 
         public void SetupDebugTargetInfo(ref VsDebugTargetInfo vsDebugTargetInfo, DebugLaunchActionContext debugLaunchContext)
         {
-            var nodeExe = debugLaunchContext.LaunchConfiguration.GetValue<string>(NodeExeKey, defaultValue: Nodejs.GetPathToNodeExecutableFromEnvironment());
+            var nodeExe = debugLaunchContext.LaunchConfiguration.GetValue(NodeExeKey, defaultValue: Nodejs.GetPathToNodeExecutableFromEnvironment());
 
             var nodeVersion = Nodejs.GetNodeVersion(nodeExe);
             if (nodeVersion >= new Version(8, 0) || NodejsProjectLauncher.CheckDebugProtocolOption())
             {
                 SetupDebugTargetInfoForWebkitV2Protocol(ref vsDebugTargetInfo, debugLaunchContext, nodeExe);
+                TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString(), isProject: false);
             }
             else
             {
                 this.SetupDebugTargetInfoForNodeProtocol(ref vsDebugTargetInfo, debugLaunchContext, nodeExe);
+                TelemetryHelper.LogDebuggingStarted("Node6", nodeVersion.ToString(), isProject: false);
             }
         }
 
@@ -117,7 +120,7 @@ private void SetupDebugTargetInfoForWebkitV2Protocol(ref VsDebugTargetInfo vsDeb
                 new JProperty("runtimeExecutable", nodeExe),
                 new JProperty("cwd", cwd),
                 new JProperty("console", "externalTerminal"),
-                new JProperty("diagnosticLogging", NodejsProjectLauncher.CheckEnableDiagnosticLoggingOption()),
+                new JProperty("trace", NodejsProjectLauncher.CheckEnableDiagnosticLoggingOption()),
                 new JProperty("sourceMaps", true),
                 new JProperty("stopOnEntry", true),
                 new JProperty("$adapter", pathToNodeExe),
diff --git a/Nodejs/Product/Nodejs/Project/NodejsProjectLauncher.cs b/Nodejs/Product/Nodejs/Project/NodejsProjectLauncher.cs
@@ -17,6 +17,7 @@
 using Microsoft.NodejsTools.Debugger;
 using Microsoft.NodejsTools.Debugger.DebugEngine;
 using Microsoft.NodejsTools.Options;
+using Microsoft.NodejsTools.Telemetry;
 using Microsoft.NodejsTools.TypeScript;
 using Microsoft.VisualStudio;
 using Microsoft.VisualStudio.Setup.Configuration;
@@ -32,8 +33,8 @@ internal class NodejsProjectLauncher : IProjectLauncher
         private readonly NodejsProjectNode _project;
         private int? _testServerPort;
 
-        public static readonly Guid WebkitDebuggerGuid = Guid.Parse("4cc6df14-0ab5-4a91-8bb4-eb0bf233d0fe");
-        public static readonly Guid WebkitPortSupplierGuid = Guid.Parse("4103f338-2255-40c0-acf5-7380e2bea13d");
+        private static readonly Guid WebkitDebuggerGuid = Guid.Parse("4cc6df14-0ab5-4a91-8bb4-eb0bf233d0fe");
+        private static readonly Guid WebkitPortSupplierGuid = Guid.Parse("4103f338-2255-40c0-acf5-7380e2bea13d");
         internal static readonly Guid WebKitDebuggerV2Guid = Guid.Parse("30d423cc-6d0b-4713-b92d-6b2a374c3d89");
 
         public NodejsProjectLauncher(NodejsProjectNode project)
@@ -71,27 +72,32 @@ private int Start(string file, bool debug)
                 return VSConstants.S_OK;
             }
 
-            var chromeProtocolRequired = Nodejs.GetNodeVersion(nodePath) >= new Version(8, 0) || CheckDebugProtocolOption();
+            var nodeVersion = Nodejs.GetNodeVersion(nodePath);
+            var chromeProtocolRequired = nodeVersion >= new Version(8, 0) || CheckDebugProtocolOption();
             var startBrowser = ShouldStartBrowser();
 
             if (debug && !chromeProtocolRequired)
             {
                 StartWithDebugger(file);
+                TelemetryHelper.LogDebuggingStarted("Node6", nodeVersion.ToString());
             }
             else if (debug && chromeProtocolRequired)
             {
                 if (CheckUseNewChromeDebugProtocolOption())
                 {
                     StartWithChromeV2Debugger(file, nodePath, startBrowser);
+                    TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString());
                 }
                 else
                 {
                     StartAndAttachDebugger(file, nodePath, startBrowser);
+                    TelemetryHelper.LogDebuggingStarted("Chrome", nodeVersion.ToString());
                 }
             }
             else
             {
                 StartNodeProcess(file, nodePath, startBrowser);
+                TelemetryHelper.LogDebuggingStarted("None", nodeVersion.ToString());
             }
 
             return VSConstants.S_OK;
diff --git a/Nodejs/Product/Nodejs/Telemetry/TelemetryEvents.cs b/Nodejs/Product/Nodejs/Telemetry/TelemetryEvents.cs
@@ -14,5 +14,33 @@ internal static class TelemetryEvents
         /// </summary>
         public const string ProjectImported = Prefix + "ProjectImported";
 
+        /// <summary>
+        /// User started debugging.
+        /// </summary>
+        public const string DebbugerStarted = Prefix + "DebuggerStarted";
+    }
+
+    internal static class TelemetryProperties
+    {
+        private const string Prefix = "VS.NodejsTools.";
+
+        /// <summary>
+        /// The engine the user is using to debug node. Expected entries are:
+        ///  * Node6
+        ///  * Chrome
+        ///  * ChromeV2
+        ///  * None
+        /// </summary>
+        public const string DebuggerEngine = Prefix + "DebuggerEngine";
+
+        /// <summary>
+        /// Wether the user started debugging inside a project or in AnyCode.
+        /// </summary>
+        public const string IsProject = Prefix + "IsProject";
+
+        /// <summary>
+        /// The version of Node the user is using.
+        /// </summary>
+        public const string NodeVersion = Prefix + "NodeVersion";
     }
 }
diff --git a/Nodejs/Product/Nodejs/Telemetry/TelemetryHelper.cs b/Nodejs/Product/Nodejs/Telemetry/TelemetryHelper.cs
@@ -5,6 +5,9 @@
 
 namespace Microsoft.NodejsTools.Telemetry
 {
+    using static TelemetryEvents;
+    using static TelemetryProperties;
+
     /// <summary>
     /// Extensions for logging telemetry events.
     /// </summary>
@@ -20,8 +23,17 @@ public static void Initialize()
 
         public static void LogProjectImported()
         {
-            defaultSession.PostUserTask(TelemetryEvents.ProjectImported, TelemetryResult.Success);
+            defaultSession.PostUserTask(ProjectImported, TelemetryResult.Success);
+        }
+
+        public static void LogDebuggingStarted(string debuggerName, string nodeVersion, bool isProject = true)
+        {
+            var userTask = new UserTaskEvent(DebbugerStarted, TelemetryResult.Success);
+            userTask.Properties[DebuggerEngine] = debuggerName;
+            userTask.Properties[NodeVersion] = nodeVersion;
+            userTask.Properties[IsProject] = isProject;
+
+            defaultSession.PostEvent(userTask);
         }
     }
 }
-

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using System.ComponentModel.Composition;`
`5`	`5`	`using System.IO;`
`6`	`6`	`using Microsoft.NodejsTools.Project;`
	`7`	`+using Microsoft.NodejsTools.Telemetry;`
`7`	`8`	`using Microsoft.VisualStudio.Setup.Configuration;`
`8`	`9`	`using Microsoft.VisualStudio.Shell.Interop;`
`9`	`10`	`using Microsoft.VisualStudio.Workspace;`
`@@ -47,16 +48,18 @@ internal class NodeJsDebugLaunchProvider : IVsDebugLaunchTargetProvider`
`47`	`48`
`48`	`49`	`public void SetupDebugTargetInfo(ref VsDebugTargetInfo vsDebugTargetInfo, DebugLaunchActionContext debugLaunchContext)`
`49`	`50`	`{`
`50`		`- var nodeExe = debugLaunchContext.LaunchConfiguration.GetValue<string>(NodeExeKey, defaultValue: Nodejs.GetPathToNodeExecutableFromEnvironment());`
	`51`	`+ var nodeExe = debugLaunchContext.LaunchConfiguration.GetValue(NodeExeKey, defaultValue: Nodejs.GetPathToNodeExecutableFromEnvironment());`
`51`	`52`
`52`	`53`	`var nodeVersion = Nodejs.GetNodeVersion(nodeExe);`
`53`	`54`	`if (nodeVersion >= new Version(8, 0) \|\| NodejsProjectLauncher.CheckDebugProtocolOption())`
`54`	`55`	`{`
`55`	`56`	`SetupDebugTargetInfoForWebkitV2Protocol(ref vsDebugTargetInfo, debugLaunchContext, nodeExe);`
	`57`	`+ TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString(), isProject: false);`
`56`	`58`	`}`
`57`	`59`	`else`
`58`	`60`	`{`
`59`	`61`	`this.SetupDebugTargetInfoForNodeProtocol(ref vsDebugTargetInfo, debugLaunchContext, nodeExe);`
	`62`	`+ TelemetryHelper.LogDebuggingStarted("Node6", nodeVersion.ToString(), isProject: false);`
`60`	`63`	`}`
`61`	`64`	`}`
`62`	`65`
`@@ -117,7 +120,7 @@ private void SetupDebugTargetInfoForWebkitV2Protocol(ref VsDebugTargetInfo vsDeb`
`117`	`120`	`new JProperty("runtimeExecutable", nodeExe),`
`118`	`121`	`new JProperty("cwd", cwd),`
`119`	`122`	`new JProperty("console", "externalTerminal"),`
`120`		`- new JProperty("diagnosticLogging", NodejsProjectLauncher.CheckEnableDiagnosticLoggingOption()),`
	`123`	`+ new JProperty("trace", NodejsProjectLauncher.CheckEnableDiagnosticLoggingOption()),`
`121`	`124`	`new JProperty("sourceMaps", true),`
`122`	`125`	`new JProperty("stopOnEntry", true),`
`123`	`126`	`new JProperty("$adapter", pathToNodeExe),`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`using Microsoft.NodejsTools.Debugger;`
`18`	`18`	`using Microsoft.NodejsTools.Debugger.DebugEngine;`
`19`	`19`	`using Microsoft.NodejsTools.Options;`
	`20`	`+using Microsoft.NodejsTools.Telemetry;`
`20`	`21`	`using Microsoft.NodejsTools.TypeScript;`
`21`	`22`	`using Microsoft.VisualStudio;`
`22`	`23`	`using Microsoft.VisualStudio.Setup.Configuration;`
`@@ -32,8 +33,8 @@ internal class NodejsProjectLauncher : IProjectLauncher`
`32`	`33`	`private readonly NodejsProjectNode _project;`
`33`	`34`	`private int? _testServerPort;`
`34`	`35`
`35`		`- public static readonly Guid WebkitDebuggerGuid = Guid.Parse("4cc6df14-0ab5-4a91-8bb4-eb0bf233d0fe");`
`36`		`- public static readonly Guid WebkitPortSupplierGuid = Guid.Parse("4103f338-2255-40c0-acf5-7380e2bea13d");`
	`36`	`+ private static readonly Guid WebkitDebuggerGuid = Guid.Parse("4cc6df14-0ab5-4a91-8bb4-eb0bf233d0fe");`
	`37`	`+ private static readonly Guid WebkitPortSupplierGuid = Guid.Parse("4103f338-2255-40c0-acf5-7380e2bea13d");`
`37`	`38`	`internal static readonly Guid WebKitDebuggerV2Guid = Guid.Parse("30d423cc-6d0b-4713-b92d-6b2a374c3d89");`
`38`	`39`
`39`	`40`	`public NodejsProjectLauncher(NodejsProjectNode project)`
`@@ -71,27 +72,32 @@ private int Start(string file, bool debug)`
`71`	`72`	`return VSConstants.S_OK;`
`72`	`73`	`}`
`73`	`74`
`74`		`- var chromeProtocolRequired = Nodejs.GetNodeVersion(nodePath) >= new Version(8, 0) \|\| CheckDebugProtocolOption();`
	`75`	`+ var nodeVersion = Nodejs.GetNodeVersion(nodePath);`
	`76`	`+ var chromeProtocolRequired = nodeVersion >= new Version(8, 0) \|\| CheckDebugProtocolOption();`
`75`	`77`	`var startBrowser = ShouldStartBrowser();`
`76`	`78`
`77`	`79`	`if (debug && !chromeProtocolRequired)`
`78`	`80`	`{`
`79`	`81`	`StartWithDebugger(file);`
	`82`	`+ TelemetryHelper.LogDebuggingStarted("Node6", nodeVersion.ToString());`
`80`	`83`	`}`
`81`	`84`	`else if (debug && chromeProtocolRequired)`
`82`	`85`	`{`
`83`	`86`	`if (CheckUseNewChromeDebugProtocolOption())`
`84`	`87`	`{`
`85`	`88`	`StartWithChromeV2Debugger(file, nodePath, startBrowser);`
	`89`	`+ TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString());`
`86`	`90`	`}`
`87`	`91`	`else`
`88`	`92`	`{`
`89`	`93`	`StartAndAttachDebugger(file, nodePath, startBrowser);`
	`94`	`+ TelemetryHelper.LogDebuggingStarted("Chrome", nodeVersion.ToString());`
`90`	`95`	`}`
`91`	`96`	`}`
`92`	`97`	`else`
`93`	`98`	`{`
`94`	`99`	`StartNodeProcess(file, nodePath, startBrowser);`
	`100`	`+ TelemetryHelper.LogDebuggingStarted("None", nodeVersion.ToString());`
`95`	`101`	`}`
`96`	`102`
`97`	`103`	`return VSConstants.S_OK;`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`
`6`	`6`	`namespace Microsoft.NodejsTools.Telemetry`
`7`	`7`	`{`
	`8`	`+ using static TelemetryEvents;`
	`9`	`+ using static TelemetryProperties;`
	`10`	`+`
`8`	`11`	`/// <summary>`
`9`	`12`	`/// Extensions for logging telemetry events.`
`10`	`13`	`/// </summary>`
`@@ -20,8 +23,17 @@ public static void Initialize()`
`20`	`23`
`21`	`24`	`public static void LogProjectImported()`
`22`	`25`	`{`
`23`		`- defaultSession.PostUserTask(TelemetryEvents.ProjectImported, TelemetryResult.Success);`
	`26`	`+ defaultSession.PostUserTask(ProjectImported, TelemetryResult.Success);`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ public static void LogDebuggingStarted(string debuggerName, string nodeVersion, bool isProject = true)`
	`30`	`+ {`
	`31`	`+ var userTask = new UserTaskEvent(DebbugerStarted, TelemetryResult.Success);`
	`32`	`+ userTask.Properties[DebuggerEngine] = debuggerName;`
	`33`	`+ userTask.Properties[NodeVersion] = nodeVersion;`
	`34`	`+ userTask.Properties[IsProject] = isProject;`
	`35`	`+`
	`36`	`+ defaultSession.PostEvent(userTask);`
`24`	`37`	`}`
`25`	`38`	`}`
`26`	`39`	`}`
`27`		`-`