Adding Client Platform and agentVersion to Exported Traces in OpenTelemetry Service

vscode/src/services/open-telemetry/CodyTraceExport.ts

@@ -1,13 +1,15 @@
 import type { ExportResult } from '@opentelemetry/core'
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
 import type { ReadableSpan } from '@opentelemetry/sdk-trace-base'
+import { CodyIDE } from '@sourcegraph/cody-shared/src/configuration'
 import type { OpenTelemetryServiceConfig } from './OpenTelemetryService.node'
 
 const MAX_TRACE_RETAIN_MS = 60 * 1000
 
 export class CodyTraceExporter extends OTLPTraceExporter {
     private queuedSpans: Map<string, { span: ReadableSpan; enqueuedAt: number }> = new Map()
-
+    private clientPlatform: CodyIDE
+    private agentVersion?: string
     constructor(private configAccessor: () => OpenTelemetryServiceConfig | null) {
         super({
             url: configAccessor()?.traceUrl,
@@ -18,6 +20,8 @@ export class CodyTraceExporter extends OTLPTraceExporter {
             },
             httpAgentOptions: { rejectUnauthorized: false },
         })
+        this.clientPlatform = configAccessor()?.clientPlatform ?? CodyIDE.VSCode
+        this.agentVersion = configAccessor()?.agentVersion
     }
 
     export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void {
@@ -43,6 +47,8 @@ export class CodyTraceExporter extends OTLPTraceExporter {
         const spanMap = new Map<string, ReadableSpan>()
         for (const span of spans) {
             spanMap.set(span.spanContext().spanId, span)
+            span.attributes.clientPlatform = this.clientPlatform
+            span.attributes.agentVersion = this.agentVersion
         }
 
         const spansToExport: ReadableSpan[] = []

vscode/src/services/open-telemetry/OpenTelemetryService.node.ts

@@ -5,8 +5,10 @@ import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node'
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
 
 import {
+    type CodyIDE,
     FeatureFlag,
     type Unsubscribable,
+    clientCapabilities,
     combineLatest,
     featureFlagProvider,
     resolvedConfig,
@@ -15,7 +17,6 @@ import {
 import { DiagConsoleLogger, DiagLogLevel, diag } from '@opentelemetry/api'
 import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base'
 import { isEqual } from 'lodash'
-import { version } from '../../version'
 import { CodyTraceExporter } from './CodyTraceExport'
 import { ConsoleBatchSpanExporter } from './console-batch-span-exporter'
 
@@ -24,6 +25,8 @@ export interface OpenTelemetryServiceConfig {
     traceUrl: string
     accessToken: string | null
     debugVerbose: boolean
+    clientPlatform: CodyIDE
+    agentVersion?: string
 }
 export class OpenTelemetryService {
     private tracerProvider?: NodeTracerProvider
@@ -45,7 +48,7 @@ export class OpenTelemetryService {
         this.tracerProvider = new NodeTracerProvider({
             resource: new Resource({
                 [SemanticResourceAttributes.SERVICE_NAME]: 'cody-client',
-                [SemanticResourceAttributes.SERVICE_VERSION]: version,
+                [SemanticResourceAttributes.SERVICE_VERSION]: clientCapabilities().agentExtensionVersion,
             }),
         })
         // Register once at startup
@@ -67,8 +70,9 @@ export class OpenTelemetryService {
                         traceUrl: traceUrl,
                         debugVerbose: configuration.debugVerbose,
                         accessToken: auth.accessToken,
+                        clientPlatform: clientCapabilities().agentIDE,
+                        agentVersion: clientCapabilities().agentExtensionVersion,
                     }
-
                     if (isEqual(this.lastConfig, newConfig)) {
                         return
                     }

vscode/webviews/App.tsx

@@ -163,8 +163,8 @@ export const App: React.FunctionComponent<{ vscodeAPI: VSCodeWrapper }> = ({ vsc
             webviewTelemetryService.configure({
                 isTracingEnabled: true,
                 debugVerbose: true,
-                agentIDE: config.clientCapabilities.agentIDE,
-                extensionAgentVersion: config.clientCapabilities.agentExtensionVersion,
+                clientPlatform: config.clientCapabilities.agentIDE,
+                agentVersion: config.clientCapabilities.agentExtensionVersion,
             })
         }
     }, [config, webviewTelemetryService])

vscode/webviews/utils/webviewOpenTelemetryService.ts

@@ -2,7 +2,7 @@ import { DiagConsoleLogger, DiagLogLevel, diag } from '@opentelemetry/api'
 import { Resource } from '@opentelemetry/resources'
 import { BatchSpanProcessor, WebTracerProvider } from '@opentelemetry/sdk-trace-web'
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
-import type { CodyIDE } from '@sourcegraph/cody-shared/src/configuration'
+import { CodyIDE } from '@sourcegraph/cody-shared/src/configuration'
 import { CodyTraceExporterWeb } from '../../src/services/open-telemetry/CodyTraceExportWeb'
 
 // This class is used to initialize and manage the OpenTelemetry service for the webview.
@@ -14,8 +14,8 @@ export class WebviewOpenTelemetryService {
     private unloadInstrumentations?: () => void
     private isTracingEnabled = false
     private isInitialized = false
-    private agentIDE?: CodyIDE
-    private extensionAgentVersion?: string
+    private clientPlatform?: CodyIDE
+    private agentVersion?: string
     constructor() {
         if (!WebviewOpenTelemetryService.instance) {
             WebviewOpenTelemetryService.instance = this
@@ -26,8 +26,8 @@ export class WebviewOpenTelemetryService {
     public configure(options?: {
         isTracingEnabled?: boolean
         debugVerbose?: boolean
-        agentIDE?: CodyIDE
-        extensionAgentVersion?: string
+        clientPlatform?: CodyIDE
+        agentVersion?: string
     }): void {
         // If the service is already initialized or if it is not the instance that is being used, return
         if (this.isInitialized || WebviewOpenTelemetryService.instance !== this) {
@@ -37,12 +37,12 @@ export class WebviewOpenTelemetryService {
         const {
             isTracingEnabled = true,
             debugVerbose = false,
-            agentIDE,
-            extensionAgentVersion,
+            clientPlatform,
+            agentVersion,
         } = options || {}
         this.isTracingEnabled = isTracingEnabled
-        this.agentIDE = agentIDE
-        this.extensionAgentVersion = extensionAgentVersion
+        this.clientPlatform = clientPlatform
+        this.agentVersion = agentVersion
         const logLevel = debugVerbose ? DiagLogLevel.INFO : DiagLogLevel.ERROR
         diag.setLogger(new DiagConsoleLogger(), logLevel)
 
@@ -58,8 +58,8 @@ export class WebviewOpenTelemetryService {
                     new BatchSpanProcessor(
                         new CodyTraceExporterWeb({
                             isTracingEnabled: true,
-                            clientPlatform: this.agentIDE ?? ('defaultIDE' as CodyIDE),
-                            agentVersion: this.extensionAgentVersion,
+                            clientPlatform: this.clientPlatform ?? CodyIDE.VSCode,
+                            agentVersion: this.agentVersion,
                         })
                     )
                 )