merge in telemetry changes

Author: Hweinstock

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

@@ -5,6 +5,12 @@
             "type": "int",
             "description": "A generic size for when units are clear"
         },
+        {
+            "name": "systemResource",
+            "type": "string",
+            "allowedValues": ["cpu", "memory"],
+            "description": "The type of system resource being measured"
+        },
         {
             "name": "amazonGenerateApproachLatency",
             "type": "double",
@@ -387,6 +393,16 @@
                 }
             ]
         },
+        {
+            "name": "ide_childProcessWarning",
+            "description": "Child Process warning due to high system usage",
+            "metadata": [
+                {
+                    "type": "systemResource",
+                    "required": true
+                }
+            ]
+        },
         {
             "name": "vscode_executeCommand",
             "description": "Emitted whenever a registered Toolkit command is executed",

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

@@ -106,19 +106,30 @@ export class ChildProcessTracker {
         }
     }
 
-    private async checkProcessUsage(pid: pid): Promise<void> {
+    private async checkProcessUsage(pid: number): Promise<void> {
+        const doesExceedThreshold = (resource: keyof ProcessStats, value: number) => {
+            const threshold = ChildProcessTracker.thresholds[resource]
+            return value > threshold
+        }
+        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 })
+            })
+        }
+
         if (!this.#pids.has(pid)) {
             this.logger.warn(`Missing process with id ${pid}`)
             return
         }
         const stats = await this.getUsage(pid)
-        if (stats) {
-            this.logger.debug(`Process ${pid} usage: %O`, stats)
-            if (stats.memory > ChildProcessTracker.thresholds.memory) {
-                this.logger.warn(`Process ${pid} exceeded memory threshold: ${stats.memory}`)
-            }
-            if (stats.cpu > ChildProcessTracker.thresholds.cpu) {
-                this.logger.warn(`Process ${pid} exceeded cpu threshold: ${stats.cpu}`)
+        if (!stats) {
+            this.logger.warn(`Failed to get process stats for ${pid}`)
+            return
+        }
+        for (const resource of Object.keys(ChildProcessTracker.thresholds) as (keyof ProcessStats)[]) {
+            if (doesExceedThreshold(resource, stats[resource])) {
+                warn(resource as keyof ProcessStats, stats[resource])
             }
         }
     }
@@ -162,7 +173,7 @@ export class ChildProcessTracker {
     }
 
     public async logAllUsage(): Promise<void> {
-        telemetry.ide_logActiveProcesses.run(async (span) => {
+        await telemetry.ide_logActiveProcesses.run(async (span) => {
             span.record({ size: this.size })
             if (this.size === 0) {
                 this.logger.info('No Active Subprocesses')

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

@@ -459,27 +459,36 @@ describe('ChildProcessTracker', function () {
             assert.strictEqual(tracker.size, 0, 'expected tracker to be empty')
         })
 
-        it('logs a warning message when system usage exceeds threshold', async function () {
+        it('logs a warning message and emits metric when cpu exceeds threshold', async function () {
             const runningProcess = startSleepProcess()
             tracker.add(runningProcess.childProcess)
 
             const highCpu: ProcessStats = {
                 cpu: ChildProcessTracker.thresholds.cpu + 1,
                 memory: 0,
             }
-            const highMemory: ProcessStats = {
-                cpu: 0,
-                memory: ChildProcessTracker.thresholds.memory + 1,
-            }
 
             usageMock.resolves(highCpu)
 
             await clock.tickAsync(ChildProcessTracker.pollingInterval)
             assertLogsContain('exceeded cpu threshold', false, 'warn')
+            assertTelemetry('ide_childProcessWarning', { systemResource: 'cpu' })
+
+            await stopAndWait(runningProcess)
+        })
+
+        it('logs a warning message and emits metric when memory exceeds threshold', async function () {
+            const runningProcess = startSleepProcess()
+            tracker.add(runningProcess.childProcess)
+            const highMemory: ProcessStats = {
+                cpu: 0,
+                memory: ChildProcessTracker.thresholds.memory + 1,
+            }
 
             usageMock.resolves(highMemory)
             await clock.tickAsync(ChildProcessTracker.pollingInterval)
             assertLogsContain('exceeded memory threshold', false, 'warn')
+            assertTelemetry('ide_childProcessWarning', { systemResource: 'memory' })
 
             await stopAndWait(runningProcess)
         })
@@ -510,12 +519,13 @@ describe('ChildProcessTracker', function () {
             await clock.tickAsync(ChildProcessTracker.pollingInterval)
 
             assert.throws(() => assertLogsContain(runningProcess.childProcess.pid().toString(), false, 'warn'))
-
+            assert.throws(() => assertTelemetry('ide_childProcessWarning', {}))
             await stopAndWait(runningProcess)
         })
     })
 
     it('logAllUsage includes only active processes', async function () {
+        console.log('start')
         const runningProcess1 = startSleepProcess()
         const runningProcess2 = startSleepProcess()
 
@@ -528,9 +538,10 @@ describe('ChildProcessTracker', function () {
         await stopAndWait(runningProcess1)
 
         await tracker.logAllUsage()
-
+        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 () {