[Monitor OpenTelemetry][Monitor OpenTelemetry Exporter] Add Operation Name Propagation for Dependencies and Logs

sdk/monitor/monitor-opentelemetry-exporter/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 1.0.0-beta.28 ()
+
+### Features Added
+
+- Added support for operation name on dependencies and logs.
+
 ## 1.0.0-beta.27 (2024-10-23)
 
 ### Other Changes

sdk/monitor/monitor-opentelemetry-exporter/src/utils/logUtils.ts

@@ -45,6 +45,11 @@ export function logToEnvelope(log: ReadableLogRecord, ikey: string): Envelope |
   const sampleRate = 100;
   const instrumentationKey = ikey;
   const tags = createTagsFromLog(log);
+  if (log.attributes[KnownContextTagKeys.AiOperationName]) {
+    tags[KnownContextTagKeys.AiOperationName] = log.attributes[
+      KnownContextTagKeys.AiOperationName
+    ] as string;
+  }
   // eslint-disable-next-line prefer-const
   let [properties, measurements] = createPropertiesFromLog(log);
   let name: string;
@@ -141,7 +146,8 @@ function createPropertiesFromLog(log: ReadableLogRecord): [Properties, Measureme
           key.startsWith("_MS.") ||
           key === ATTR_EXCEPTION_TYPE ||
           key === ATTR_EXCEPTION_MESSAGE ||
-          key === ATTR_EXCEPTION_STACKTRACE
+          key === ATTR_EXCEPTION_STACKTRACE ||
+          key === (KnownContextTagKeys.AiOperationName as string)
         )
       ) {
         properties[key] = serializeAttribute(log.attributes[key]);

sdk/monitor/monitor-opentelemetry-exporter/src/utils/spanUtils.ts

@@ -107,8 +107,14 @@ function createTagsFromSpan(span: ReadableSpan): Tags {
         tags[KnownContextTagKeys.AiLocationIp] = String(netPeerIp);
       }
     }
+  } else {
+    if (span.attributes[KnownContextTagKeys.AiOperationName]) {
+      tags[KnownContextTagKeys.AiOperationName] = span.attributes[
+        KnownContextTagKeys.AiOperationName
+      ] as string;
+    }
   }
-  // TODO: Operation Name and Location IP TBD for non server spans
+  // TODO: Location IP TBD for non server spans
 
   return tags;
 }
@@ -141,7 +147,8 @@ function createPropertiesFromSpanAttributes(attributes?: Attributes): {
           key === SEMATTRS_RPC_GRPC_STATUS_CODE ||
           key === SEMATTRS_EXCEPTION_TYPE ||
           key === SEMATTRS_EXCEPTION_MESSAGE ||
-          key === SEMATTRS_EXCEPTION_STACKTRACE
+          key === SEMATTRS_EXCEPTION_STACKTRACE ||
+          key === (KnownContextTagKeys.AiOperationName as string)
         )
       ) {
         properties[key] = serializeAttribute(attributes[key]);

sdk/monitor/monitor-opentelemetry/CHANGELOG.md

@@ -19,7 +19,7 @@
 
 ### Other Changes
 
-- Update to using the logRecordProcessors property.
+- Update to using the logRecordProcessors property. 
 
 ## 1.7.1 (2024-09-13)
 

sdk/monitor/monitor-opentelemetry/src/logs/logRecordProcessor.ts

@@ -1,8 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import { Context, trace } from "@opentelemetry/api";
 import type { MetricHandler } from "../metrics/handler";
 import type { LogRecord, LogRecordProcessor } from "@opentelemetry/sdk-logs";
+import { ReadableSpan } from "@opentelemetry/sdk-trace-base";
+import { AI_OPERATION_NAME } from "../types";
 
 /**
  * Azure Monitor LogRecord Processor.
@@ -15,7 +18,12 @@ export class AzureLogRecordProcessor implements LogRecordProcessor {
     this._metricHandler = metricHandler;
   }
 
-  public onEmit(logRecord: LogRecord): void {
+  public onEmit(logRecord: LogRecord, context: Context): void {
+    const parentSpan = trace.getSpan(context);
+    if (parentSpan && "name" in parentSpan) {
+      // If the parent span has a name we can assume it's a ReadableSpan and cast it as such
+      logRecord.attributes[AI_OPERATION_NAME] = (parentSpan as unknown as ReadableSpan).name;
+    }
     this._metricHandler.recordLog(logRecord);
   }
 

sdk/monitor/monitor-opentelemetry/src/traces/spanProcessor.ts

@@ -1,9 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import type { Context } from "@opentelemetry/api";
+import { trace, type Context } from "@opentelemetry/api";
 import type { ReadableSpan, Span, SpanProcessor } from "@opentelemetry/sdk-trace-base";
 import type { MetricHandler } from "../metrics";
+import { AI_OPERATION_NAME } from "../types";
 
 /**
  * Azure Monitor Span Processor.
@@ -21,6 +22,11 @@ export class AzureMonitorSpanProcessor implements SpanProcessor {
   }
 
   onStart(span: Span, _context: Context): void {
+    const parentSpan = trace.getSpan(_context);
+    if (parentSpan && "name" in parentSpan) {
+      // If the parent span has a name we can assume it's a ReadableSpan and cast it as such
+      span.attributes[AI_OPERATION_NAME] = (parentSpan as unknown as ReadableSpan).name;
+    }
     this._metricHandler.markSpanAsProcessed(span);
   }
 

sdk/monitor/monitor-opentelemetry/src/types.ts

@@ -174,6 +174,11 @@ export const DEFAULT_BREEZE_ENDPOINT = "https://dc.services.visualstudio.com";
  * @internal
  */
 export const DEFAULT_LIVEMETRICS_ENDPOINT = "https://global.livediagnostics.monitor.azure.com";
+/**
+ * Operation Name attribute name.
+ * @internal
+ */
+export const AI_OPERATION_NAME = "ai.operation.name";
 
 /**
  * Internal attribute name for sample rate

sdk/monitor/monitor-opentelemetry/test/internal/unit/traces/traceHandler.test.ts

@@ -19,6 +19,7 @@ import type {
 import type { ProxyTracerProvider, Span } from "@opentelemetry/api";
 import { metrics, trace } from "@opentelemetry/api";
 import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+import { AI_OPERATION_NAME } from "../../../../src/types";
 
 describe("Library/TraceHandler", () => {
   let http: any = null;
@@ -350,5 +351,28 @@ describe("Library/TraceHandler", () => {
           done(error);
         });
     });
+
+    it("Span processing propagates operation id", (done) => {
+      createHandler({ enabled: true });
+      makeHttpRequest()
+        .then(() => {
+          ((trace.getTracerProvider() as ProxyTracerProvider).getDelegate() as NodeTracerProvider)
+            .forceFlush()
+            .then(() => {
+              assert.ok(exportStub.calledOnce, "Export called");
+              const spans = exportStub.args[0][0];
+              assert.deepStrictEqual(spans.length, 2);
+              // Outgoing request
+              assert.deepStrictEqual(spans[1].attributes[AI_OPERATION_NAME], "test");
+              done();
+            })
+            .catch((error) => {
+              done(error);
+            });
+        })
+        .catch((error) => {
+          done(error);
+        });
+    });
   });
 });