add process as str to telemetry

Author: Hweinstock

packages/core/src/shared/telemetry/vscodeTelemetry.json

@@ -5,6 +5,11 @@
             "type": "int",
             "description": "A generic size for when units are clear"
         },
+        {
+            "name": "childProcess",
+            "type": "string",
+            "description": "A string representation of a ChildProcess"
+        },
         {
             "name": "systemResource",
             "type": "string",
@@ -400,6 +405,10 @@
                 {
                     "type": "systemResource",
                     "required": true
+                },
+                {
+                    "type": "childProcess",
+                    "required": true
                 }
             ]
         },

packages/core/src/shared/utilities/processUtils.ts

@@ -113,18 +113,18 @@ export class ChildProcessTracker {
         }
         const warn = (resource: keyof ProcessStats, value: number) => {
             telemetry.ide_childProcessWarning.run((span) => {
-                this.logger.warn(`Process ${pid} exceeded ${resource} threshold: ${value}`)
-                span.record({ systemResource: resource })
+                this.logger.warn(`Process ${this.getProcessAsStr(pid)} exceeded ${resource} threshold: ${value}`)
+                span.record({ systemResource: resource, childProcess: this.getProcessAsStr(pid) })
             })
         }
 
         if (!this.#pids.has(pid)) {
-            this.logger.warn(`Missing process with id ${pid}`)
+            this.logger.warn(`Missing process with pid ${pid}`)
             return
         }
         const stats = await this.getUsage(pid)
         if (!stats) {
-            this.logger.warn(`Failed to get process stats for ${pid}`)
+            this.logger.warn(`Failed to get process stats for process with pid ${pid}`)
             return
         }
         for (const resource of Object.keys(ChildProcessTracker.thresholds) as (keyof ProcessStats)[]) {
@@ -134,6 +134,15 @@ export class ChildProcessTracker {
         }
     }
 
+    public getProcessAsStr(pid: pid): string {
+        try {
+            return this.#processByPid.get(pid)!.toString()
+        } catch (e) {
+            this.logger.warn(`Missing process with pid ${pid}`)
+            return `pid: ${pid}`
+        }
+    }
+
     public add(childProcess: ChildProcess) {
         const pid = childProcess.pid()
         this.#processByPid.set(pid, childProcess)

packages/core/src/test/shared/utilities/processUtils.test.ts

@@ -472,7 +472,10 @@ describe('ChildProcessTracker', function () {
 
             await clock.tickAsync(ChildProcessTracker.pollingInterval)
             assertLogsContain('exceeded cpu threshold', false, 'warn')
-            assertTelemetry('ide_childProcessWarning', { systemResource: 'cpu' })
+            assertTelemetry('ide_childProcessWarning', {
+                systemResource: 'cpu',
+                childProcess: runningProcess.childProcess.toString(),
+            })
 
             await stopAndWait(runningProcess)
         })
@@ -488,7 +491,10 @@ describe('ChildProcessTracker', function () {
             usageMock.resolves(highMemory)
             await clock.tickAsync(ChildProcessTracker.pollingInterval)
             assertLogsContain('exceeded memory threshold', false, 'warn')
-            assertTelemetry('ide_childProcessWarning', { systemResource: 'memory' })
+            assertTelemetry('ide_childProcessWarning', {
+                systemResource: 'memory',
+                childProcess: runningProcess.childProcess.toString(),
+            })
 
             await stopAndWait(runningProcess)
         })
@@ -525,7 +531,6 @@ describe('ChildProcessTracker', function () {
     })
 
     it('logAllUsage includes only active processes', async function () {
-        console.log('start')
         const runningProcess1 = startSleepProcess()
         const runningProcess2 = startSleepProcess()
 
@@ -541,7 +546,6 @@ describe('ChildProcessTracker', function () {
         console.log('logAllUsage called')
         assert.throws(() => assertLogsContain(runningProcess1.childProcess.pid().toString(), false, 'info'))
         assertLogsContain(runningProcess2.childProcess.pid().toString(), false, 'info')
-        console.log('end')
     })
 
     it('logAllUsage defaults to empty message when empty', async function () {
@@ -564,4 +568,11 @@ describe('ChildProcessTracker', function () {
         await tracker.logAllUsage()
         assertTelemetry('ide_logActiveProcesses', { size: size })
     })
+
+    it('getProcessAsStr logs warning when its missing', async function () {
+        const runningProcess1 = startSleepProcess()
+        tracker.clear()
+        tracker.getProcessAsStr(runningProcess1.childProcess.pid())
+        assertLogsContain(runningProcess1.childProcess.pid().toString(), false, 'warn')
+    })
 })