feat: Add global flag for tracking runtime performance in a metric

Author: jpinkney-aws

telemetry/telemetrySchema.json

@@ -65,6 +65,10 @@
                     "passive": {
                         "type": "boolean",
                         "description": "Set as true if the metric is emitted without any explicit user action."
+                    },
+                    "performanceTracking": {
+                        "type": "boolean",
+                        "description": "Set as true if the metric should track run-time performance information."
                     }
                 },
                 "required": ["name", "description"]

telemetry/telemetryformat.md

@@ -89,6 +89,8 @@ result: Result
 passive: boolean
 // Value based on unit and call type
 value: number
+// Indicates that the metric should track run-time performance information
+trackPerformance: boolean
 ```
 
 If not specified `createTime` defaults to UTC now, `value` defaults to `1.0`.

telemetry/vscode/src/generate.ts

@@ -153,6 +153,15 @@ const passive: PropertySignatureStructure = {
     kind: StructureKind.PropertySignature,
 }
 
+const trackPerformance: PropertySignatureStructure = {
+    isReadonly: true,
+    hasQuestionToken: true,
+    name: 'trackPerformance',
+    type: 'boolean',
+    docs: ['A flag indicating that the metric should track run-time performance information'],
+    kind: StructureKind.PropertySignature,
+}
+
 const value: PropertySignatureStructure = {
     isReadonly: true,
     hasQuestionToken: true,
@@ -177,6 +186,11 @@ const runtimeMetricDefinition: InterfaceDeclarationStructure = {
             type: 'boolean',
             isReadonly: true,
         },
+        {
+            name: 'trackPerformance',
+            type: 'boolean',
+            isReadonly: true,
+        },
         {
             name: 'requiredMetadata',
             type: 'readonly string[]',
@@ -214,7 +228,7 @@ function generateMetricBase(types: MetadataType[] | undefined): InterfaceDeclara
         name: baseName,
         isExported: true,
         kind: StructureKind.Interface,
-        properties: commonMetadata.map(toProp).concat(passive, value),
+        properties: commonMetadata.map(toProp).concat(passive, value, trackPerformance),
     }    
 }
 
@@ -325,7 +339,7 @@ function generateDefinitions(metrics: Metric[]): VariableStatementStructure {
         const metadataTypes = getMetricMetadata(m).filter(m => m.required ?? true).map(m => `'${m.type}'`)
         const requiredMetadata = `[${metadataTypes.join(', ')}]`
 
-        return `${m.name}: { unit: '${m.unit ?? 'None'}', passive: ${m.passive ?? false}, requiredMetadata: ${requiredMetadata} }`
+        return `${m.name}: { unit: '${m.unit ?? 'None'}', passive: ${m.passive ?? false}, trackPerformance: ${m.trackPerformance ?? false}, requiredMetadata: ${requiredMetadata} }`
     })
 
     return {

telemetry/vscode/src/parser.ts

@@ -34,6 +34,7 @@ export interface Metric {
     readonly unit?: string
     readonly metadata?: MetricMetadata[]
     readonly passive?: boolean
+    readonly trackPerformance?: boolean
 }
 
 export interface MetricDefinitionRoot {

telemetry/vscode/test/resources/generatorOutput.ts

@@ -34,6 +34,8 @@ export interface MetricBase {
     readonly passive?: boolean
     /** @deprecated Arbitrary "value" of the metric. */
     readonly value?: number
+    /** A flag indicating that the metric should track run-time performance information */
+    readonly trackPerformance?: boolean
 }
 
 export interface LambdaDelete extends MetricBase {
@@ -93,6 +95,7 @@ export type Runtime =
 export interface MetricDefinition {
     readonly unit: string
     readonly passive: boolean
+    readonly trackPerformance: boolean
     readonly requiredMetadata: readonly string[]
 }
 
@@ -107,11 +110,11 @@ export interface MetricShapes {
 export type MetricName = keyof MetricShapes
 
 export const definitions: Record<string, MetricDefinition> = {
-    lambda_delete: { unit: 'None', passive: false, requiredMetadata: ['isRetry'] },
-    lambda_create: { unit: 'None', passive: false, requiredMetadata: ['runtime', 'userId'] },
-    lambda_remoteinvoke: { unit: 'None', passive: false, requiredMetadata: ['successCount'] },
-    no_metadata: { unit: 'None', passive: false, requiredMetadata: [] },
-    passive_passive: { unit: 'None', passive: true, requiredMetadata: [] },
+    lambda_delete: { unit: 'None', passive: false, trackPerformance: false, requiredMetadata: ['isRetry'] },
+    lambda_create: { unit: 'None', passive: false, trackPerformance: false, requiredMetadata: ['runtime', 'userId'] },
+    lambda_remoteinvoke: { unit: 'None', passive: false, trackPerformance: false, requiredMetadata: ['successCount'] },
+    no_metadata: { unit: 'None', passive: false, trackPerformance: false, requiredMetadata: [] },
+    passive_passive: { unit: 'None', passive: true, trackPerformance: false, requiredMetadata: [] },
 }
 
 export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase> | Partial<Pick<MetricBase, 'awsRegion'>>>

telemetry/vscode/test/resources/generatorOverrideOutput.ts

@@ -34,6 +34,8 @@ export interface MetricBase {
     readonly passive?: boolean
     /** @deprecated Arbitrary "value" of the metric. */
     readonly value?: number
+    /** A flag indicating that the metric should track run-time performance information */
+    readonly trackPerformance?: boolean
 }
 
 export interface MetadataHasResult extends MetricBase {}
@@ -72,6 +74,7 @@ export type Runtime =
 export interface MetricDefinition {
     readonly unit: string
     readonly passive: boolean
+    readonly trackPerformance: boolean
     readonly requiredMetadata: readonly string[]
 }
 
@@ -82,7 +85,7 @@ export interface MetricShapes {
 export type MetricName = keyof MetricShapes
 
 export const definitions: Record<string, MetricDefinition> = {
-    metadata_hasResult: { unit: 'None', passive: false, requiredMetadata: [] },
+    metadata_hasResult: { unit: 'None', passive: false, trackPerformance: false, requiredMetadata: [] },
 }
 
 export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase> | Partial<Pick<MetricBase, 'awsRegion'>>>