refactor: Move trackPerformance to a property on telemetry (aws#5472)

## Problem
Cleanup how trackPerformance is used

## Solution
aws/aws-toolkit-common#823

Author: jpinkney-aws

package-lock.json

@@ -39,7 +39,7 @@
         "generateNonCodeFiles": "npm run generateNonCodeFiles -w packages/ --if-present"
     },
     "devDependencies": {
-        "@aws-toolkits/telemetry": "^1.0.240",
+        "@aws-toolkits/telemetry": "^1.0.247",
         "@playwright/browser-chromium": "^1.43.1",
         "@types/vscode": "^1.68.0",
         "@types/vscode-webview": "^1.57.1",

package.json

@@ -35,8 +35,8 @@ export class PerformanceTracker {
 
     constructor(private readonly name: string) {}
 
-    static enabled(name: string, trackPerformance?: boolean): boolean {
-        return name === 'function_call' && (trackPerformance ?? false) && !isWeb()
+    static enabled(name: string, trackPerformance: boolean): boolean {
+        return name === 'function_call' && trackPerformance && !isWeb()
     }
 
     start() {

packages/core/src/shared/performance/performance.ts

@@ -98,9 +98,6 @@ export type SpanOptions = {
     /** True if this span should emit its telemetry events. Defaults to true if undefined. */
     emit?: boolean
 
-    /** True if this span should emit performance metrics acquired when running the function. Defaults to false if undefined */
-    trackPerformance?: boolean
-
     /**
      * Adds a function entry to the span stack.
      *
@@ -137,7 +134,9 @@ export type SpanOptions = {
  */
 export class TelemetrySpan<T extends MetricBase = MetricBase> {
     #startTime?: Date
-    #options: SpanOptions
+    #options: SpanOptions & {
+        trackPerformance: boolean
+    }
     #performance?: PerformanceTracker
 
     private readonly state: Partial<T> = {}
@@ -162,7 +161,10 @@ export class TelemetrySpan<T extends MetricBase = MetricBase> {
             // do emit by default
             emit: options?.emit === undefined ? true : options.emit,
             functionId: options?.functionId,
-            trackPerformance: PerformanceTracker.enabled(this.name, options?.trackPerformance),
+            trackPerformance: PerformanceTracker.enabled(
+                this.name,
+                this.definition.trackPerformance && (options?.emit ?? false) // only track the performance if we are also emitting
+            ),
         }
     }
 

packages/core/src/shared/telemetry/spans.ts

@@ -8,18 +8,13 @@
         {
             "name": "documentFormat",
             "type": "string",
-            "allowedValues": [
-                "JSON, YAML"
-            ],
+            "allowedValues": ["JSON, YAML"],
             "description": "SSM Create document format selection"
         },
         {
             "name": "ssmOperation",
             "type": "string",
-            "allowedValues": [
-                "Create",
-                "Update"
-            ],
+            "allowedValues": ["Create", "Update"],
             "description": "SSM Publish Document operation type"
         },
         {
@@ -45,11 +40,7 @@
         {
             "name": "cwsprChatTriggerInteraction",
             "type": "string",
-            "allowedValues": [
-                "hotkeys",
-                "click",
-                "contextMenu"
-            ],
+            "allowedValues": ["hotkeys", "click", "contextMenu"],
             "description": "Identifies the specific interaction that opens the chat panel"
         },
         {
@@ -114,11 +105,7 @@
         {
             "name": "cwsprChatConversationType",
             "type": "string",
-            "allowedValues": [
-                "Chat",
-                "Assign",
-                "Transform"
-            ],
+            "allowedValues": ["Chat", "Assign", "Transform"],
             "description": "Identifies the type of conversation"
         },
         {
@@ -245,12 +232,7 @@
         {
             "name": "cwsprChatCommandType",
             "type": "string",
-            "allowedValues": [
-                "clear",
-                "help",
-                "transform",
-                "auth"
-            ],
+            "allowedValues": ["clear", "help", "transform", "auth"],
             "description": "Type of chat command (/command) executed"
         },
         {
@@ -266,11 +248,7 @@
         {
             "name": "authStatus",
             "type": "string",
-            "allowedValues": [
-                "connected",
-                "notConnected",
-                "expired"
-            ],
+            "allowedValues": ["connected", "notConnected", "expired"],
             "description": "Status of the an auth connection."
         },
         {
@@ -1129,7 +1107,8 @@
                     "required": true
                 }
             ],
-            "passive": true
+            "passive": true,
+            "trackPerformance": true
         }
     ]
-}
+}

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

@@ -386,7 +386,6 @@ export async function collectFiles(
         },
         {
             emit: true,
-            trackPerformance: true,
             functionId: {
                 name: 'collectFiles',
             },

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

@@ -80,7 +80,7 @@ describe('TelemetrySpan', function () {
     it('records performance', function () {
         const { expectedCpuUsage, expectedHeapTotal } = stubPerformance(sandbox)
         const span = new TelemetrySpan('function_call', {
-            trackPerformance: true,
+            emit: true,
         })
         span.start()
         clock.tick(90)
@@ -276,7 +276,7 @@ describe('TelemetryTracer', function () {
                     clock?.tick(90)
                 },
                 {
-                    trackPerformance: true,
+                    emit: true,
                 }
             )