Merge pull request #4337 from aws/gajjardh/refactor-add-ComputeEnv-telemetry

WIP - added Compute Env to Post metrics

Author: dhruvigajjar

package-lock.json

@@ -64,6 +64,22 @@
       "type":"string",
       "max":2000
     },
+    "ComputeEnv":{
+      "type":"string",
+      "enum":[
+        "cloud9",
+        "cloud9-codecatalyst",
+        "codecatalyst",
+        "ec2",
+        "local",
+        "sagemaker",
+        "ssh",
+        "test",
+        "web",
+        "wsl",
+        "unknown"
+      ]
+    },
     "Datapoint":{
       "type":"double",
       "min":0
@@ -169,6 +185,7 @@
         "AWSProductVersion":{"shape":"AWSProductVersion"},
         "OS":{"shape":"Value"},
         "OSVersion":{"shape":"Value"},
+        "ComputeEnv": {"shape":"ComputeEnv"},
         "ParentProduct":{"shape":"Value"},
         "ParentProductVersion":{"shape":"Value"},
         "Metadata":{"shape":"Metadata"},
@@ -190,6 +207,7 @@
         "ClientID":{"shape":"ClientID"},
         "OS":{"shape":"Value"},
         "OSVersion":{"shape":"Value"},
+        "ComputeEnv": {"shape":"ComputeEnv"},
         "ParentProduct":{"shape":"Value"},
         "ParentProductVersion":{"shape":"Value"},
         "MetricData":{"shape":"MetricData"}

packages/toolkit/src/shared/telemetry/service-2.json

@@ -17,6 +17,7 @@ import { ServiceConfigurationOptions } from 'aws-sdk/lib/service'
 import globals from '../extensionGlobals'
 import { DevSettings } from '../settings'
 import { ClassToInterfaceType } from '../utilities/tsUtils'
+import { getComputeEnvType } from './util'
 
 export const accountMetadataKey = 'awsAccount'
 export const regionKey = 'awsRegion'
@@ -91,6 +92,7 @@ export class DefaultTelemetryClient implements TelemetryClient {
                         ClientID: this.clientId,
                         OS: os.platform(),
                         OSVersion: os.release(),
+                        ComputeEnv: getComputeEnvType(),
                         ParentProduct: vscode.env.appName,
                         ParentProductVersion: vscode.version,
                         MetricData: batch,
@@ -117,12 +119,14 @@ export class DefaultTelemetryClient implements TelemetryClient {
                     AWSProductVersion: extensionVersion,
                     OS: os.platform(),
                     OSVersion: os.release(),
+                    ComputeEnv: getComputeEnvType(),
                     ParentProduct: vscode.env.appName,
                     ParentProductVersion: vscode.version,
                     Comment: feedback.comment,
                     Sentiment: feedback.sentiment,
                 })
                 .promise()
+            this.logger.debug(`ComputeEnv detected for telemetry: ${getComputeEnvType()}`)
             this.logger.info('Successfully posted feedback')
         } catch (err) {
             this.logger.error(`Failed to post feedback: ${err}`)

packages/toolkit/src/shared/telemetry/telemetryClient.ts

@@ -15,6 +15,8 @@ import { mapMetadata } from './telemetryLogger'
 import { Result } from './telemetry.gen'
 import { MetricDatum } from './clienttelemetry'
 import { isValidationExemptMetric } from './exemptMetrics'
+import { isCloud9, isSageMaker } from '../../shared/extensionUtilities'
+import { isInDevEnv } from '../../codecatalyst/utils'
 
 const legacySettingsTelemetryValueDisable = 'Disable'
 const legacySettingsTelemetryValueEnable = 'Enable'
@@ -90,6 +92,28 @@ export async function getUserAgent(
     return pairs.join(' ')
 }
 
+type EnvType = 'cloud9' | 'cloud9-codecatalyst' | 'codecatalyst' | 'local' | 'ec2' | 'sagemaker' | 'test' | 'unknown'
+
+export function getComputeEnvType(): EnvType {
+    if (isCloud9('classic')) {
+        return 'cloud9'
+    } else if (isCloud9('codecatalyst')) {
+        return 'cloud9-codecatalyst'
+    } else if (isInDevEnv()) {
+        return 'codecatalyst'
+    } else if (isSageMaker()) {
+        return 'sagemaker'
+    } else if (env.remoteName === 'ssh-remote' && !isInDevEnv()) {
+        return 'ec2'
+    } else if (isAutomation()) {
+        return 'test'
+    } else if (!env.remoteName) {
+        return 'local'
+    } else {
+        return 'unknown'
+    }
+}
+
 /**
  * Validates that emitted telemetry metrics
  * 1. contain a result property and