feat(telemetry): add attributes and increment (#3432)

## Problem
* `spans.ts` can be simplified
* Some telemetry/logging is too noisy
* `vscode_executeCommand` is not a span

## Solution
Change the behavior to make it less confusing. Spans are now more independent. It's also now possible to record information on all future spans bound to a context.

### Other Changes
* Silence 4 CW commands that are triggered whenever auth changes
* Remove throttle on `aws.auth.addConnection`
    * I'd like to remove the throttle on everything eventually

Author: JadenSimon

package.json

@@ -3299,133 +3299,133 @@
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1a5"
+                    "fontCharacter": "\\f1aa"
                 }
             },
             "aws-cdk-logo": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1a6"
+                    "fontCharacter": "\\f1ab"
                 }
             },
             "aws-cloudformation-stack": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1a7"
+                    "fontCharacter": "\\f1ac"
                 }
             },
             "aws-cloudwatch-log-group": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1a8"
+                    "fontCharacter": "\\f1ad"
                 }
             },
             "aws-codecatalyst-logo": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1a9"
+                    "fontCharacter": "\\f1ae"
                 }
             },
             "aws-ecr-registry": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1aa"
+                    "fontCharacter": "\\f1af"
                 }
             },
             "aws-ecs-cluster": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1ab"
+                    "fontCharacter": "\\f1b0"
                 }
             },
             "aws-ecs-container": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1ac"
+                    "fontCharacter": "\\f1b1"
                 }
             },
             "aws-ecs-service": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1ad"
+                    "fontCharacter": "\\f1b2"
                 }
             },
             "aws-generic-attach-file": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1ae"
+                    "fontCharacter": "\\f1b3"
                 }
             },
             "aws-iot-certificate": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1af"
+                    "fontCharacter": "\\f1b4"
                 }
             },
             "aws-iot-policy": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b0"
+                    "fontCharacter": "\\f1b5"
                 }
             },
             "aws-iot-thing": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b1"
+                    "fontCharacter": "\\f1b6"
                 }
             },
             "aws-lambda-function": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b2"
+                    "fontCharacter": "\\f1b7"
                 }
             },
             "aws-s3-bucket": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b3"
+                    "fontCharacter": "\\f1b8"
                 }
             },
             "aws-s3-create-bucket": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b4"
+                    "fontCharacter": "\\f1b9"
                 }
             },
             "aws-schemas-registry": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b5"
+                    "fontCharacter": "\\f1ba"
                 }
             },
             "aws-schemas-schema": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b6"
+                    "fontCharacter": "\\f1bb"
                 }
             },
             "aws-stepfunctions-preview": {
                 "description": "AWS Contributed Icon",
                 "default": {
                     "fontPath": "./resources/fonts/aws-toolkit-icons.woff",
-                    "fontCharacter": "\\f1b7"
+                    "fontCharacter": "\\f1bc"
                 }
             }
         }

src/codecatalyst/commands.ts

@@ -10,7 +10,7 @@ const localize = nls.loadMessageBundle()
 
 import * as vscode from 'vscode'
 import { selectCodeCatalystRepository, selectCodeCatalystResource } from './wizards/selectResource'
-import { openCodeCatalystUrl, recordSource } from './utils'
+import { openCodeCatalystUrl } from './utils'
 import { CodeCatalystAuthenticationProvider } from './auth'
 import { Commands } from '../shared/vscode/commands2'
 import { CodeCatalystClient, CodeCatalystResource, createClient } from '../shared/clients/codecatalystClient'
@@ -234,7 +234,7 @@ export class CodeCatalystCommands {
     }
 
     public updateDevEnv(...args: WithClient<typeof updateDevEnv>) {
-        telemetry.codecatalyst_updateDevEnvironmentSettings.record({
+        telemetry.record({
             codecatalyst_updateDevEnvironmentLocationType: 'remote',
         })
 
@@ -272,7 +272,7 @@ export class CodeCatalystCommands {
         // need to be careful of mapping explosion so this granular data would either need
         // to be flattened or we restrict the names to a pre-determined set
         if (id === undefined) {
-            recordSource('CommandPalette')
+            telemetry.record({ source: 'CommandPalette' })
         }
 
         return this.withClient(openDevEnv, devenv, targetPath)

src/codecatalyst/reconnect.ts

@@ -15,8 +15,9 @@ import { showViewLogsMessage } from '../shared/utilities/messages'
 import { CodeCatalystAuthenticationProvider } from './auth'
 import { getCodeCatalystDevEnvId } from '../shared/vscode/env'
 import globals from '../shared/extensionGlobals'
-import { isDevenvVscode, recordSource } from './utils'
+import { isDevenvVscode } from './utils'
 import { SsoConnection } from '../credentials/auth'
+import { telemetry } from '../shared/telemetry/telemetry'
 
 const localize = nls.loadMessageBundle()
 
@@ -238,14 +239,16 @@ async function openReconnectedDevEnv(
         project: { name: devenv.projectName },
     }
 
-    recordSource('Reconnect')
-    await codeCatalystConnectCommand.execute(client, identifier, devenv.previousVscodeWorkspace)
+    await telemetry.runRoot(async () => {
+        telemetry.record({ source: 'Reconnect' })
+        await codeCatalystConnectCommand.execute(client, identifier, devenv.previousVscodeWorkspace)
 
-    // When we only have 1 devenv to watch we might as well close the local vscode instance
-    if (closeRootInstance) {
-        // A brief delay ensures that metrics are saved from the connect command
-        sleep(5000).then(() => vscode.commands.executeCommand('workbench.action.closeWindow'))
-    }
+        // When we only have 1 devenv to watch we might as well close the local vscode instance
+        if (closeRootInstance) {
+            // A brief delay ensures that metrics are saved from the connect command
+            sleep(5000).then(() => vscode.commands.executeCommand('workbench.action.closeWindow'))
+        }
+    })
 }
 
 function getDevEnvName(alias: string | undefined, id: string) {

src/codecatalyst/uriHandlers.ts

@@ -7,15 +7,12 @@ import * as vscode from 'vscode'
 import { SearchParams, UriHandler } from '../shared/vscode/uriHandler'
 import { getCodeCatalystConfig } from '../shared/clients/codecatalystClient'
 import { CodeCatalystCommands } from './commands'
-import { recordSource } from './utils'
 
 export function register(
     handler: UriHandler,
     commands: Pick<typeof CodeCatalystCommands.declared, 'cloneRepo' | 'openDevEnv'>
 ) {
     async function cloneHandler(params: ReturnType<typeof parseCloneParams>) {
-        recordSource('UriHandler')
-
         if (params.url.authority.endsWith(getCodeCatalystConfig().gitHostname)) {
             await commands.cloneRepo.execute(params.url)
         } else {
@@ -24,8 +21,6 @@ export function register(
     }
 
     async function connectHandler(params: ReturnType<typeof parseConnectParams | typeof parseConnectParamsOld>) {
-        recordSource('UriHandler')
-
         await commands.openDevEnv.execute({
             id: params.devEnvironmentId,
             org: { name: 'spaceName' in params ? params.spaceName : params.organizationName },

src/codecatalyst/utils.ts

@@ -7,7 +7,6 @@ import { Ides } from 'aws-sdk/clients/codecatalyst'
 import * as vscode from 'vscode'
 import { CodeCatalystResource, getCodeCatalystConfig } from '../shared/clients/codecatalystClient'
 import { pushIf } from '../shared/utilities/collectionUtils'
-import { telemetry } from '../shared/telemetry/telemetry'
 
 /**
  * Builds a web URL from the given CodeCatalyst object.
@@ -56,9 +55,3 @@ export function openCodeCatalystUrl(o: CodeCatalystResource) {
 export function isDevenvVscode(ides: Ides | undefined): boolean {
     return ides !== undefined && ides.findIndex(ide => ide.name === 'VSCode') !== -1
 }
-
-export function recordSource(source: 'Webview' | 'UriHandler' | 'Reconnect' | 'CommandPalette') {
-    // TODO: add `source` (or something similar) as a base component to events
-    telemetry.codecatalyst_connect.record({ source } as any)
-    telemetry.codecatalyst_localClone.record({ source } as any)
-}

src/codecatalyst/vue/create/backend.ts

@@ -32,7 +32,6 @@ import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { isCloud9 } from '../../../shared/extensionUtilities'
 import { telemetry } from '../../../shared/telemetry/telemetry'
 import { isNonNullable } from '../../../shared/utilities/tsUtils'
-import { recordSource } from '../../utils'
 import { createOrgPrompter, createProjectPrompter } from '../../wizards/selectResource'
 import { GetSourceRepositoryCloneUrlsRequest } from 'aws-sdk/clients/codecatalyst'
 import { QuickPickPrompter } from '../../../shared/ui/pickerPrompter'
@@ -197,8 +196,10 @@ export class CodeCatalystCreateWebview extends VueWebview {
             }
         })()
 
-        recordSource('Webview')
-        telemetry.codecatalyst_createDevEnvironment.record({ codecatalyst_createDevEnvironmentRepoType: source.type })
+        telemetry.record({
+            source: 'Webview',
+            codecatalyst_createDevEnvironmentRepoType: source.type,
+        })
 
         this.onComplete(devenv)
         return devenv

src/codewhisperer/commands/basicCommands.ts

@@ -132,9 +132,12 @@ export const showFreeTierLimit = Commands.declare('aws.codeWhisperer.freeTierLim
     vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
 })
 
-export const updateReferenceLog = Commands.declare('aws.codeWhisperer.updateReferenceLog', () => () => {
-    ReferenceLogViewProvider.instance.update()
-})
+export const updateReferenceLog = Commands.declare(
+    { id: 'aws.codeWhisperer.updateReferenceLog', logging: false },
+    () => () => {
+        ReferenceLogViewProvider.instance.update()
+    }
+)
 
 async function showCodeWhispererWelcomeMessage(context: ExtContext): Promise<void> {
     const filePath = isCloud9()
@@ -144,12 +147,15 @@ async function showCodeWhispererWelcomeMessage(context: ExtContext): Promise<voi
     await vscode.commands.executeCommand('markdown.showPreviewToSide', readmeUri)
 }
 
-export const refreshStatusBar = Commands.declare('aws.codeWhisperer.refreshStatusBar', () => () => {
-    if (AuthUtil.instance.isConnectionValid()) {
-        InlineCompletionService.instance.setCodeWhispererStatusBarOk()
-    } else if (AuthUtil.instance.isConnectionExpired()) {
-        InlineCompletionService.instance.setCodeWhispererStatusBarDisconnected()
-    } else {
-        InlineCompletionService.instance.hideCodeWhispererStatusBar()
+export const refreshStatusBar = Commands.declare(
+    { id: 'aws.codeWhisperer.refreshStatusBar', logging: false },
+    () => () => {
+        if (AuthUtil.instance.isConnectionValid()) {
+            InlineCompletionService.instance.setCodeWhispererStatusBarOk()
+        } else if (AuthUtil.instance.isConnectionExpired()) {
+            InlineCompletionService.instance.setCodeWhispererStatusBarDisconnected()
+        } else {
+            InlineCompletionService.instance.hideCodeWhispererStatusBar()
+        }
     }
-})
+)

src/codewhisperer/explorer/codewhispererNode.ts

@@ -102,11 +102,17 @@ export class CodeWhispererNode implements RootNode {
 }
 
 export const codewhispererNode = new CodeWhispererNode()
-export const refreshCodeWhisperer = Commands.register('aws.codeWhisperer.refresh', (showFreeTierLimitNode = false) => {
-    codewhispererNode.updateShowFreeTierLimitReachedNode(showFreeTierLimitNode)
-    codewhispererNode.refresh()
-})
+export const refreshCodeWhisperer = Commands.register(
+    { id: 'aws.codeWhisperer.refresh', logging: false },
+    (showFreeTierLimitNode = false) => {
+        codewhispererNode.updateShowFreeTierLimitReachedNode(showFreeTierLimitNode)
+        codewhispererNode.refresh()
+    }
+)
 
-export const refreshCodeWhispererRootNode = Commands.register('aws.codeWhisperer.refreshRootNode', () => {
-    codewhispererNode.refreshRootNode()
-})
+export const refreshCodeWhispererRootNode = Commands.register(
+    { id: 'aws.codeWhisperer.refreshRootNode', logging: false },
+    () => {
+        codewhispererNode.refreshRootNode()
+    }
+)

src/credentials/auth.ts

@@ -1164,7 +1164,7 @@ Commands.register('aws.auth.signout', () => {
     return signout(Auth.instance)
 })
 
-const addConnection = Commands.register('aws.auth.addConnection', async () => {
+const addConnection = Commands.register({ id: 'aws.auth.addConnection', telemetryThrottleMs: false }, async () => {
     const c9IamItem = createIamItem()
     c9IamItem.detail =
         'Activates working with resources in the Explorer. Requires an access key ID and secret access key.'

src/extension.ts

@@ -139,7 +139,16 @@ export async function activate(context: vscode.ExtensionContext) {
         awsFiletypes.activate()
 
         globals.uriHandler = new UriHandler()
-        context.subscriptions.push(vscode.window.registerUriHandler(globals.uriHandler))
+        context.subscriptions.push(
+            vscode.window.registerUriHandler({
+                handleUri: uri =>
+                    telemetry.runRoot(() => {
+                        telemetry.record({ source: 'UriHandler' })
+
+                        return globals.uriHandler.handleUri(uri)
+                    }),
+            })
+        )
 
         const extContext: ExtContext = {
             extensionContext: context,
@@ -324,7 +333,7 @@ function recordToolkitInitialization(activationStartedOn: number, logger?: Logge
  *
  * Cloud9 does not show a progress notification.
  */
-function wrapWithProgressForCloud9(channel: vscode.OutputChannel): typeof vscode.window['withProgress'] {
+function wrapWithProgressForCloud9(channel: vscode.OutputChannel): (typeof vscode.window)['withProgress'] {
     const withProgress = vscode.window.withProgress.bind(vscode.window)
 
     return (options, task) => {