@ai-sdk/otel 1.0.0-canary.71 → 1.0.0-canary.73

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @ai-sdk/otel
 
+## 1.0.0-canary.73
+
+### Patch Changes
+
+- c025d60: feat(otel): add option for custom span attributes
+- Updated dependencies [e95e38d]
+- Updated dependencies [016e877]
+- Updated dependencies [ca99fea]
+- Updated dependencies [d775a57]
+- Updated dependencies [538c12b]
+  - ai@7.0.0-canary.127
+
+## 1.0.0-canary.72
+
+### Patch Changes
+
+- ai@7.0.0-canary.126
+
 ## 1.0.0-canary.71
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,13 +1,25 @@
 import { Telemetry, InferTelemetryEvent, GenerateTextStartEvent, GenerateObjectStartEvent, EmbedStartEvent, RerankStartEvent, GenerateObjectStepStartEvent, GenerateObjectStepEndEvent, GenerateTextStepStartEvent, ToolSet, LanguageModelCallStartEvent, LanguageModelCallEndEvent, ToolExecutionStartEvent, ToolExecutionEndEvent, GenerateTextStepEndEvent, GenerateTextEndEvent, GenerateObjectEndEvent, EmbedEndEvent, RerankEndEvent, EmbeddingModelCallStartEvent, EmbeddingModelCallEndEvent, RerankingModelCallStartEvent, RerankingModelCallEndEvent, StreamTextChunkEvent, OutputInterface } from 'ai';
-import { Tracer } from '@opentelemetry/api';
+import { Attributes, Tracer } from '@opentelemetry/api';
 import { LanguageModelV4Prompt } from '@ai-sdk/provider';
 import { Context } from '@ai-sdk/provider-utils';
 
+type OpenTelemetrySpanType = 'operation' | 'step' | 'languageModel' | 'tool' | 'embedding' | 'reranking';
+type EnrichSpan = (options: {
+    spanType: OpenTelemetrySpanType;
+    operationId: string;
+    callId: string;
+    runtimeContext: Record<string, unknown> | undefined;
+}) => Attributes | undefined;
 type OpenTelemetryOptions = {
     /**
      * The tracer to use for the telemetry data.
      */
     tracer?: Tracer;
+    /**
+     * Adds custom attributes to spans when they are created. These attributes are
+     * not AI SDK-owned semantics and are intended for observability integrations.
+     */
+    enrichSpan?: EnrichSpan;
     /**
      * Emit AI SDK usage details that are not represented by GenAI SemConv.
      */
@@ -49,9 +61,11 @@ declare class OpenTelemetry implements Telemetry {
     private readonly callStates;
     private readonly tracer;
     private readonly supplementalAttributes;
+    private readonly enrichSpan;
     constructor(options?: OpenTelemetryOptions);
     private getCallState;
     private cleanupCallState;
+    private getSpanAttributes;
     executeTool<T>({ callId, toolCallId, execute, }: {
         callId: string;
         toolCallId: string;
@@ -132,4 +146,4 @@ declare class LegacyOpenTelemetry implements Telemetry {
     onError(error: unknown): void;
 }
 
-export { LegacyOpenTelemetry, OpenTelemetry };
+export { type EnrichSpan, LegacyOpenTelemetry, OpenTelemetry, type OpenTelemetryOptions, type OpenTelemetrySpanType };

package/dist/index.js

@@ -556,6 +556,7 @@ var OpenTelemetry = class {
     var _a;
     this.tracer = (_a = options.tracer) != null ? _a : trace.getTracer("gen_ai");
     this.supplementalAttributes = normalizeSupplementalAttributes(options);
+    this.enrichSpan = options.enrichSpan;
   }
   getCallState(callId) {
     return this.callStates.get(callId);
@@ -563,6 +564,30 @@ var OpenTelemetry = class {
   cleanupCallState(callId) {
     this.callStates.delete(callId);
   }
+  getSpanAttributes({
+    attributes,
+    spanType,
+    operationId,
+    callId,
+    runtimeContext
+  }) {
+    var _a;
+    let customAttributes;
+    try {
+      customAttributes = (_a = this.enrichSpan) == null ? void 0 : _a.call(this, {
+        spanType,
+        operationId,
+        callId,
+        runtimeContext
+      });
+    } catch (e) {
+      customAttributes = void 0;
+    }
+    return {
+      ...customAttributes,
+      ...attributes
+    };
+  }
   executeTool({
     callId,
     toolCallId,
@@ -614,13 +639,12 @@ var OpenTelemetry = class {
     };
     const providerName = mapProviderName(event.provider);
     const operationName = mapOperationName(event.operationId);
+    const runtimeContext = event.runtimeContext;
     const baseSupplementalAttributes = selectSupplementalAttributes(
       telemetry,
       this.supplementalAttributes,
       {
-        runtimeContext: getRuntimeContextAttributes(
-          event.runtimeContext
-        ),
+        runtimeContext: getRuntimeContextAttributes(runtimeContext),
         headers: getHeaderAttributes(event.headers)
       }
     );
@@ -637,8 +661,8 @@ var OpenTelemetry = class {
       "gen_ai.request.top_p": event.topP,
       "gen_ai.request.stop_sequences": event.stopSequences,
       "gen_ai.request.seed": event.seed,
-      "gen_ai.system_instructions": event.system ? {
-        input: () => JSON.stringify(formatSystemInstructions(event.system))
+      "gen_ai.system_instructions": event.instructions ? {
+        input: () => JSON.stringify(formatSystemInstructions(event.instructions))
       } : void 0,
       "gen_ai.input.messages": {
         input: () => JSON.stringify(
@@ -652,7 +676,13 @@ var OpenTelemetry = class {
     });
     const spanName = `${operationName} ${event.modelId}`;
     const rootSpan = this.tracer.startSpan(spanName, {
-      attributes,
+      attributes: this.getSpanAttributes({
+        attributes,
+        spanType: "operation",
+        operationId: event.operationId,
+        callId: event.callId,
+        runtimeContext
+      }),
       kind: SpanKind.INTERNAL
     });
     const rootContext = trace.setSpan(context2.active(), rootSpan);
@@ -671,6 +701,7 @@ var OpenTelemetry = class {
       settings,
       provider: event.provider,
       modelId: event.modelId,
+      runtimeContext,
       baseSupplementalAttributes
     });
   }
@@ -736,7 +767,13 @@ var OpenTelemetry = class {
     });
     const spanName = `${operationName} ${event.modelId}`;
     const rootSpan = this.tracer.startSpan(spanName, {
-      attributes,
+      attributes: this.getSpanAttributes({
+        attributes,
+        spanType: "operation",
+        operationId: event.operationId,
+        callId: event.callId,
+        runtimeContext: void 0
+      }),
       kind: SpanKind.INTERNAL
     });
     const rootContext = trace.setSpan(context2.active(), rootSpan);
@@ -755,6 +792,7 @@ var OpenTelemetry = class {
       settings,
       provider: event.provider,
       modelId: event.modelId,
+      runtimeContext: void 0,
       baseSupplementalAttributes
     });
   }
@@ -784,7 +822,16 @@ var OpenTelemetry = class {
     const spanName = `chat ${event.modelId}`;
     state.inferenceSpan = this.tracer.startSpan(
       spanName,
-      { attributes, kind: SpanKind.CLIENT },
+      {
+        attributes: this.getSpanAttributes({
+          attributes,
+          spanType: "languageModel",
+          operationId: state.operationId,
+          callId: event.callId,
+          runtimeContext: state.runtimeContext
+        }),
+        kind: SpanKind.CLIENT
+      },
       state.rootContext
     );
     state.inferenceContext = trace.setSpan(
@@ -871,7 +918,13 @@ var OpenTelemetry = class {
     });
     const spanName = `embeddings ${event.modelId}`;
     const rootSpan = this.tracer.startSpan(spanName, {
-      attributes,
+      attributes: this.getSpanAttributes({
+        attributes,
+        spanType: "operation",
+        operationId: event.operationId,
+        callId: event.callId,
+        runtimeContext: void 0
+      }),
       kind: SpanKind.CLIENT
     });
     const rootContext = trace.setSpan(context2.active(), rootSpan);
@@ -890,6 +943,7 @@ var OpenTelemetry = class {
       settings: { maxRetries: event.maxRetries },
       provider: event.provider,
       modelId: event.modelId,
+      runtimeContext: void 0,
       baseSupplementalAttributes
     });
   }
@@ -897,6 +951,7 @@ var OpenTelemetry = class {
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.rootSpan) || !state.rootContext) return;
     const { telemetry } = state;
+    state.runtimeContext = event.runtimeContext;
     const stepAttributes = selectAttributes(telemetry, {
       "gen_ai.operation.name": "agent_step",
       ...state.baseSupplementalAttributes,
@@ -910,7 +965,16 @@ var OpenTelemetry = class {
     });
     state.stepSpan = this.tracer.startSpan(
       `step ${event.steps.length + 1}`,
-      { attributes: stepAttributes, kind: SpanKind.INTERNAL },
+      {
+        attributes: this.getSpanAttributes({
+          attributes: stepAttributes,
+          spanType: "step",
+          operationId: state.operationId,
+          callId: event.callId,
+          runtimeContext: state.runtimeContext
+        }),
+        kind: SpanKind.INTERNAL
+      },
       state.rootContext
     );
     state.stepContext = trace.setSpan(state.rootContext, state.stepSpan);
@@ -947,7 +1011,16 @@ var OpenTelemetry = class {
     });
     state.inferenceSpan = this.tracer.startSpan(
       `chat ${event.modelId}`,
-      { attributes: inferenceAttributes, kind: SpanKind.CLIENT },
+      {
+        attributes: this.getSpanAttributes({
+          attributes: inferenceAttributes,
+          spanType: "languageModel",
+          operationId: state.operationId,
+          callId: event.callId,
+          runtimeContext: state.runtimeContext
+        }),
+        kind: SpanKind.CLIENT
+      },
       state.stepContext
     );
     state.inferenceContext = trace.setSpan(
@@ -1009,7 +1082,16 @@ var OpenTelemetry = class {
     const spanName = `execute_tool ${toolCall.toolName}`;
     const toolSpan = this.tracer.startSpan(
       spanName,
-      { attributes, kind: SpanKind.INTERNAL },
+      {
+        attributes: this.getSpanAttributes({
+          attributes,
+          spanType: "tool",
+          operationId: state.operationId,
+          callId: event.callId,
+          runtimeContext: state.runtimeContext
+        }),
+        kind: SpanKind.INTERNAL
+      },
       state.stepContext
     );
     const toolContext = trace.setSpan(state.stepContext, toolSpan);
@@ -1202,7 +1284,16 @@ var OpenTelemetry = class {
     const spanName = `embeddings ${state.modelId}`;
     const embedSpan = this.tracer.startSpan(
       spanName,
-      { attributes, kind: SpanKind.CLIENT },
+      {
+        attributes: this.getSpanAttributes({
+          attributes,
+          spanType: "embedding",
+          operationId: state.operationId,
+          callId: event.callId,
+          runtimeContext: state.runtimeContext
+        }),
+        kind: SpanKind.CLIENT
+      },
       state.rootContext
     );
     const embedContext = trace.setSpan(state.rootContext, embedSpan);
@@ -1266,7 +1357,13 @@ var OpenTelemetry = class {
     });
     const spanName = `rerank ${event.modelId}`;
     const rootSpan = this.tracer.startSpan(spanName, {
-      attributes,
+      attributes: this.getSpanAttributes({
+        attributes,
+        spanType: "operation",
+        operationId: event.operationId,
+        callId: event.callId,
+        runtimeContext: void 0
+      }),
       kind: SpanKind.CLIENT
     });
     const rootContext = trace.setSpan(context2.active(), rootSpan);
@@ -1285,6 +1382,7 @@ var OpenTelemetry = class {
       settings: { maxRetries: event.maxRetries },
       provider: event.provider,
       modelId: event.modelId,
+      runtimeContext: void 0,
       baseSupplementalAttributes
     });
   }
@@ -1315,7 +1413,16 @@ var OpenTelemetry = class {
     const spanName = `rerank ${state.modelId}`;
     const rerankSpan = this.tracer.startSpan(
       spanName,
-      { attributes, kind: SpanKind.CLIENT },
+      {
+        attributes: this.getSpanAttributes({
+          attributes,
+          spanType: "reranking",
+          operationId: state.operationId,
+          callId: event.callId,
+          runtimeContext: state.runtimeContext
+        }),
+        kind: SpanKind.CLIENT
+      },
       state.rootContext
     );
     const rerankContext = trace.setSpan(state.rootContext, rerankSpan);
@@ -1581,7 +1688,7 @@ var LegacyOpenTelemetry = class {
       "ai.model.id": event.modelId,
       "ai.prompt": {
         input: () => JSON.stringify({
-          system: event.system,
+          system: event.instructions,
           messages: event.messages
         })
       }