telemetry: code transform data byte size, result field #4180

Problem:
1. Code Transform artifact upload and download metrics for VSCode did not have totalByteSize.
2. Need to emit dependenciesCopied metric.
3. Several Code Transform metrics did not have `result` field.

Solution:
1. Include totalByteSize where applicable.
2. Emit dependenciesCopied metric.
3. Add `result` field to metrics.

Validated dependenciesCopied emitted:

- `telemetry: emitted metric "codeTransform_dependenciesCopied" -> {"Metadata":[{"Key":"parentMetric","Value":"vscode_executeCommand"},{"Key":"codeTransformSessionId","Value":"<redacted>"},{"Key":"result","Value":"Succeeded"},{"Key":"awsAccount","Value":"not-set"},{"Key":"awsRegion","Value":"us-west-2"}],"MetricName":"codeTransform_dependenciesCopied","Value":1,"Unit":"None","Passive":false,"EpochTimestamp":1702660044892}`

Validated metrics are emitted with expected TotalByteSize:

- `telemetry: emitted metric "codeTransform_jobCreateZipEndTime" -> {"Metadata":[{"Key":"parentMetric","Value":"vscode_executeCommand"},{"Key":"codeTransformSessionId","Value":"<redacted>"},{"Key":"codeTransformTotalByteSize","Value":"2522725"},{"Key":"codeTransformRunTimeLatency","Value":"11208"},{"Key":"result","Value":"Succeeded"},{"Key":"awsAccount","Value":"not-set"},{"Key":"awsRegion","Value":"us-west-2"}],"MetricName":"codeTransform_jobCreateZipEndTime","Value":1,"Unit":"None","Passive":false,"EpochTimestamp":1702660047014}`
- `telemetry: emitted metric "codeTransform_logApiLatency" -> {"Metadata":[{"Key":"parentMetric","Value":"vscode_executeCommand"},{"Key":"codeTransformApiNames","Value":"UploadZip"},{"Key":"codeTransformSessionId","Value":"<redacted>"},
{"Key":"codeTransformUploadId","Value":"<redacted>"},{"Key":"codeTransformRunTimeLatency","Value":"5667"},{"Key":"codeTransformTotalByteSize","Value":"2522725"},{"Key":"result","Value":"Succeeded"},{"Key":"awsAccount","Value":"not-set"},{"Key":"awsRegion","Value":"us-west-2"}],"MetricName":"codeTransform_logApiLatency","Value":1,"Unit":"None","Passive":true,"EpochTimestamp":1702660057297}`
- `telemetry: emitted metric "codeTransform_jobArtifactDownloadAndDeserializeTime" -> {"Metadata":[{"Key":"codeTransformSessionId","Value":"<redacted>"},{"Key":"codeTransformJobId","Value":"<redacted>"},{"Key":"codeTransformRunTimeLatency","Value":"70"},{"Key":"codeTransformTotalByteSize","Value":"152486"},{"Key":"result","Value":"Succeeded"},{"Key":"awsAccount","Value":"not-set"},{"Key":"awsRegion","Value":"us-west-2"}],"MetricName":"codeTransform_jobArtifactDownloadAndDeserializeTime","Value":1,"Unit":"None","Passive":false,"EpochTimestamp":1702660482671}`
- `telemetry: emitted metric "codeTransform_logApiLatency" -> {"Metadata":[{"Key":"codeTransformApiNames","Value":"ExportResultArchive"},{"Key":"codeTransformSessionId","Value":"<redacted>"},{"Key":"codeTransformJobId","Value":"<redacted>"},{"Key":"codeTransformRunTimeLatency","Value":"1133"},{"Key":"codeTransformTotalByteSize","Value":"152486"},{"Key":"codeTransformRequestId","Value":"<redacted>"},{"Key":"awsAccount","Value":"not-set"},{"Key":"awsRegion","Value":"us-west-2"}],"MetricName":"codeTransform_logApiLatency","Value":1,"Unit":"None","Passive":true,"EpochTimestamp":1702660482600}`

Author: tincheng

.changes/next-release/Feature-20c6488b-1750-4ca6-9eb3-b509f49f194b.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Code Transform Telemetry includes additional metadata"
+}

src/amazonqGumby/telemetry/codeTransformTelemetry.ts

@@ -10,6 +10,7 @@ import { telemetry } from '../../shared/telemetry/telemetry'
 import { JDKVersion } from '../../codewhisperer/models/model'
 import * as CodeWhispererConstants from '../../codewhisperer/models/constants'
 import { codeTransformTelemetryState } from './codeTransformTelemetryState'
+import { MetadataResult } from '../../shared/telemetry/telemetryClient'
 
 export enum CancelActionPositions {
     ApiError = 'apiError',
@@ -32,11 +33,13 @@ export const logCodeTransformInitiatedMetric = (source: string): void => {
         telemetry.codeTransform_isDoubleClickedToTriggerUserModal.emit({
             codeTransformStartSrcComponents: StartActionPositions.DevToolsSidePanel,
             ...commonMetrics,
+            result: MetadataResult.Pass,
         })
     } else if (source === StartActionPositions.BottomHubPanel) {
         telemetry.codeTransform_isDoubleClickedToTriggerUserModal.emit({
             codeTransformStartSrcComponents: StartActionPositions.BottomHubPanel,
             ...commonMetrics,
+            result: MetadataResult.Pass,
         })
     }
 }

src/codewhisperer/commands/startTransformByQ.ts

@@ -37,6 +37,7 @@ import { codeTransformTelemetryState } from '../../amazonqGumby/telemetry/codeTr
 import { ToolkitError } from '../../shared/errors'
 import { TransformByQUploadArchiveFailed } from '../../amazonqGumby/models/model'
 import { CancelActionPositions, toJDKMetricValue } from '../../amazonqGumby/telemetry/codeTransformTelemetry'
+import { MetadataResult } from '../../shared/telemetry/telemetryClient'
 
 const localize = nls.loadMessageBundle()
 export const stopTransformByQButton = localize('aws.codewhisperer.stop.transform.by.q', 'Stop')
@@ -122,11 +123,13 @@ export async function startTransformByQ() {
     if (selection !== 'Transform') {
         telemetry.codeTransform_jobIsCanceledFromUserPopupClick.emit({
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            result: MetadataResult.Pass,
         })
         throw new ToolkitError('Transform cancelled', { code: 'DidNotConfirmDisclaimer', cancelled: true })
     } else {
         telemetry.codeTransform_jobIsStartedFromUserPopupClick.emit({
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            result: MetadataResult.Pass,
         })
     }
 
@@ -146,6 +149,7 @@ export async function startTransformByQ() {
         codeTransformJavaTargetVersionsAllowed: toJDKMetricValue(
             transformByQState.getTargetJDKVersion()
         ) as CodeTransformJavaTargetVersionsAllowed,
+        result: MetadataResult.Pass,
     })
 
     vscode.commands.executeCommand('workbench.view.extension.aws-codewhisperer-transformation-hub')
@@ -347,6 +351,7 @@ export async function confirmStopTransformByQ(
         telemetry.codeTransform_jobIsCancelledByUser.emit({
             codeTransformCancelSrcComponents: cancelSrc,
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            result: MetadataResult.Pass,
         })
     }
 }

src/codewhisperer/service/transformByQHandler.ts

@@ -95,6 +95,7 @@ export async function validateProjectSelection(project: vscode.QuickPickItem) {
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformPreValidationError: 'NoJavaProject',
             result: MetadataResult.Fail,
+            reason: 'NoJavaProjectsAvailable',
         })
         throw new TransformByQJavaProjectNotFound()
     }
@@ -109,6 +110,7 @@ export async function validateProjectSelection(project: vscode.QuickPickItem) {
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformPreValidationError: 'NoJavaProject',
             result: MetadataResult.Fail,
+            reason: 'CannotDetermineJavaVersion',
         })
         throw new ToolkitError('Unable to determine Java version', {
             code: 'CannotDetermineJavaVersion',
@@ -151,6 +153,7 @@ export async function validateProjectSelection(project: vscode.QuickPickItem) {
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformPreValidationError: 'NoPom',
             result: MetadataResult.Fail,
+            reason: 'CouldNotFindPomXml',
         })
         throw new ToolkitError('No valid Maven build file found', { code: 'CouldNotFindPomXml' })
     }
@@ -196,8 +199,8 @@ export async function uploadArtifactToS3(fileName: string, resp: CreateUploadUrl
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformUploadId: resp.uploadId,
             codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
-            // TODO: A nice to have would be getting the zipUploadSize
-            codeTransformTotalByteSize: 0,
+            codeTransformTotalByteSize: (await fs.promises.stat(fileName)).size,
+            result: MetadataResult.Pass,
         })
         getLogger().info(`CodeTransform: Status from S3 Upload = ${response.status}`)
     } catch (e: any) {
@@ -208,6 +211,8 @@ export async function uploadArtifactToS3(fileName: string, resp: CreateUploadUrl
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformApiErrorMessage: errorMessage,
             codeTransformRequestId: e?.requestId,
+            result: MetadataResult.Fail,
+            reason: 'UploadToS3Failed',
         })
         // Pass along error to callee function
         throw new ToolkitError(errorMessage, { cause: e as Error })
@@ -228,6 +233,7 @@ export async function stopJob(jobId: string) {
                     codeTransformJobId: jobId,
                     codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
                     codeTransformRequestId: response.$response.requestId,
+                    result: MetadataResult.Pass,
                 })
             }
         } catch (e: any) {
@@ -239,6 +245,8 @@ export async function stopJob(jobId: string) {
                 codeTransformJobId: jobId,
                 codeTransformApiErrorMessage: e?.message || errorMessage,
                 codeTransformRequestId: e?.requestId,
+                result: MetadataResult.Fail,
+                reason: 'StopTransformationFailed',
             })
             throw new ToolkitError(errorMessage, { cause: e as Error })
         }
@@ -262,6 +270,7 @@ export async function uploadPayload(payloadFileName: string) {
             codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
             codeTransformUploadId: response.uploadId,
             codeTransformRequestId: response.$response.requestId,
+            result: MetadataResult.Pass,
         })
         await uploadArtifactToS3(payloadFileName, response)
         return response.uploadId
@@ -273,6 +282,8 @@ export async function uploadPayload(payloadFileName: string) {
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformApiErrorMessage: errorMessage,
             codeTransformRequestId: e?.requestId,
+            result: MetadataResult.Fail,
+            reason: 'CreateUploadUrlFailed',
         })
         // Pass along error to callee function
         throw new ToolkitError(errorMessage, { cause: e as Error })
@@ -375,6 +386,10 @@ export async function zipCode(modulePath: string) {
             zip.addLocalFile(file, path.dirname(paddedPath))
         }
         zipManifest.dependenciesRoot += `${dependencyFolderName}/`
+        telemetry.codeTransform_dependenciesCopied.emit({
+            codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            result: MetadataResult.Pass,
+        })
     } else {
         zipManifest.dependenciesRoot = undefined
     }
@@ -393,8 +408,7 @@ export async function zipCode(modulePath: string) {
     const mavenStatus = mavenFailed ? MetadataResult.Fail : MetadataResult.Pass
     telemetry.codeTransform_jobCreateZipEndTime.emit({
         codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
-        // TODO: A nice to have would be getting the zipUploadSize
-        codeTransformTotalByteSize: 0,
+        codeTransformTotalByteSize: (await fs.promises.stat(tempFilePath)).size,
         codeTransformRunTimeLatency: calculateTotalLatency(zipStartTime),
         result: mavenStatus,
         reason: mavenFailed ? 'MavenCommandFailed' : undefined,
@@ -424,6 +438,7 @@ export async function startJob(uploadId: string) {
             codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
             codeTransformJobId: response.transformationJobId,
             codeTransformRequestId: response.$response.requestId,
+            result: MetadataResult.Pass,
         })
         return response.transformationJobId
     } catch (e: any) {
@@ -434,6 +449,8 @@ export async function startJob(uploadId: string) {
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformApiErrorMessage: errorMessage,
             codeTransformRequestId: e?.requestId,
+            result: MetadataResult.Fail,
+            reason: 'StartTransformationFailed',
         })
         // Pass along error to callee function
         throw new ToolkitError(errorMessage, { cause: e as Error })
@@ -457,6 +474,7 @@ export async function getTransformationPlan(jobId: string) {
             codeTransformJobId: jobId,
             codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
             codeTransformRequestId: response.$response.requestId,
+            result: MetadataResult.Pass,
         })
         const logoAbsolutePath = globals.context.asAbsolutePath(
             path.join('resources', 'icons', 'aws', 'amazonq', 'transform-landing-page-icon.svg')
@@ -483,6 +501,8 @@ export async function getTransformationPlan(jobId: string) {
             codeTransformJobId: jobId,
             codeTransformApiErrorMessage: errorMessage,
             codeTransformRequestId: e?.requestId,
+            result: MetadataResult.Fail,
+            reason: 'GetTransformationPlanFailed',
         })
         // Pass along error to callee function
         throw new ToolkitError(errorMessage, { cause: e as Error })
@@ -502,6 +522,7 @@ export async function getTransformationSteps(jobId: string) {
             codeTransformJobId: jobId,
             codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
             codeTransformRequestId: response.$response.requestId,
+            result: MetadataResult.Pass,
         })
         return response.transformationPlan.transformationSteps
     } catch (e: any) {
@@ -513,6 +534,8 @@ export async function getTransformationSteps(jobId: string) {
             codeTransformJobId: jobId,
             codeTransformApiErrorMessage: errorMessage,
             codeTransformRequestId: e?.requestId,
+            result: MetadataResult.Fail,
+            reason: 'GetTransformationPlanFailed',
         })
         throw e
     }
@@ -534,6 +557,7 @@ export async function pollTransformationJob(jobId: string, validStates: string[]
                 codeTransformJobId: jobId,
                 codeTransformRunTimeLatency: calculateTotalLatency(apiStartTime),
                 codeTransformRequestId: response.$response.requestId,
+                result: MetadataResult.Pass,
             })
             status = response.transformationJob.status!
             if (response.transformationJob.reason) {
@@ -546,6 +570,7 @@ export async function pollTransformationJob(jobId: string, validStates: string[]
                     codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                     codeTransformJobId: jobId,
                     codeTransformStatus: status,
+                    result: MetadataResult.Pass,
                 })
             }
             transformByQState.setPolledJobStatus(status)
@@ -570,6 +595,8 @@ export async function pollTransformationJob(jobId: string, validStates: string[]
                 codeTransformJobId: jobId,
                 codeTransformApiErrorMessage: errorMessage,
                 codeTransformRequestId: e?.requestId,
+                result: MetadataResult.Fail,
+                reason: 'GetTransformationFailed',
             })
             // Pass along error to callee function
             throw new ToolkitError(errorMessage, { cause: e as Error })

src/codewhisperer/service/transformationResultsViewProvider.ts

@@ -19,6 +19,7 @@ import { getLogger } from '../../shared/logger'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { codeTransformTelemetryState } from '../../amazonqGumby/telemetry/codeTransformTelemetryState'
 import { calculateTotalLatency } from '../../amazonqGumby/telemetry/codeTransformTelemetry'
+import { MetadataResult } from '../../shared/telemetry/telemetryClient'
 
 export abstract class ProposedChangeNode {
     abstract readonly resourcePath: string
@@ -286,10 +287,14 @@ export class ProposedTransformationExplorer {
                     codeTransformJobId: transformByQState.getJobId(),
                     codeTransformApiErrorMessage: e?.message || errorMessage,
                     codeTransformRequestId: e?.requestId,
+                    result: MetadataResult.Fail,
+                    reason: 'ExportResultArchiveFailed',
                 })
                 throw new ToolkitError(errorMessage)
             }
 
+            const exportResultsArchiveSize = (await fs.promises.stat(pathToArchive)).size
+
             let deserializeErrorMessage
             const deserializeArchiveStartTime = Date.now()
             try {
@@ -309,15 +314,16 @@ export class ProposedTransformationExplorer {
                 )
             } catch (e: any) {
                 deserializeErrorMessage = e?.message || 'Error during deserialization of result archive'
-            } finally {
                 getLogger().error('CodeTransform: ParseDiff error = ', deserializeErrorMessage)
+            } finally {
                 telemetry.codeTransform_jobArtifactDownloadAndDeserializeTime.emit({
                     codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                     codeTransformJobId: transformByQState.getJobId(),
                     codeTransformRunTimeLatency: calculateTotalLatency(deserializeArchiveStartTime),
-                    // TODO: A nice to have would be getting the zip download size
-                    codeTransformTotalByteSize: 0,
+                    codeTransformTotalByteSize: exportResultsArchiveSize,
                     codeTransformRuntimeError: deserializeErrorMessage,
+                    result: deserializeErrorMessage ? MetadataResult.Fail : MetadataResult.Pass,
+                    reason: deserializeErrorMessage ? 'DeserializationFailed' : undefined,
                 })
             }
 
@@ -329,6 +335,7 @@ export class ProposedTransformationExplorer {
             telemetry.codeTransform_vcsDiffViewerVisible.emit({
                 codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                 codeTransformJobId: transformByQState.getJobId(),
+                result: MetadataResult.Pass,
             })
         })
 
@@ -346,6 +353,7 @@ export class ProposedTransformationExplorer {
             telemetry.codeTransform_vcsViewerSubmitted.emit({
                 codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                 codeTransformJobId: transformByQState.getJobId(),
+                result: MetadataResult.Pass,
             })
         })
 
@@ -360,6 +368,7 @@ export class ProposedTransformationExplorer {
                 codeTransformPatchViewerCancelSrcComponents: 'cancelButton',
                 codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                 codeTransformJobId: transformByQState.getJobId(),
+                result: MetadataResult.Pass,
             })
         })
     }