@ai-sdk/otel 1.0.0-beta.5 → 1.0.0-beta.50

package/src/get-base-telemetry-attributes.ts

@@ -1,16 +1,16 @@
 import { Attributes, AttributeValue } from '@opentelemetry/api';
-import type { CallSettings, TelemetrySettings } from 'ai';
+import type { LanguageModelCallOptions } from 'ai';
 
 export function getBaseTelemetryAttributes({
   model,
   settings,
-  telemetry,
   headers,
+  context,
 }: {
   model: { modelId: string; provider: string };
-  settings: Omit<CallSettings, 'abortSignal' | 'headers' | 'temperature'>;
-  telemetry: TelemetrySettings | undefined;
+  settings: LanguageModelCallOptions;
   headers: Record<string, string | undefined> | undefined;
+  context: Record<string, unknown> | undefined;
 }): Attributes {
   return {
     'ai.model.provider': model.provider,
@@ -22,16 +22,13 @@ export function getBaseTelemetryAttributes({
       return attributes;
     }, {} as Attributes),
 
-    // add metadata as attributes:
-    ...Object.entries(telemetry?.metadata ?? {}).reduce(
-      (attributes, [key, value]) => {
-        if (value != undefined) {
-          attributes[`ai.telemetry.metadata.${key}`] = value as AttributeValue;
-        }
-        return attributes;
-      },
-      {} as Attributes,
-    ),
+    // add context as attributes:
+    ...Object.entries(context ?? {}).reduce((attributes, [key, value]) => {
+      if (value != undefined) {
+        attributes[`ai.settings.context.${key}`] = value as AttributeValue;
+      }
+      return attributes;
+    }, {} as Attributes),
 
     // request headers
     ...Object.entries(headers ?? {}).reduce((attributes, [key, value]) => {

package/src/index.ts

@@ -1 +1,2 @@
+export { GenAIOpenTelemetryIntegration } from './gen-ai-open-telemetry-integration';
 export { OpenTelemetryIntegration } from './open-telemetry-integration';

package/src/open-telemetry-integration.ts

@@ -1,9 +1,10 @@
 import { LanguageModelV4Prompt } from '@ai-sdk/provider';
+import type { Context as AISDKContext } from '@ai-sdk/provider-utils';
 import {
   Attributes,
   AttributeValue,
   context,
-  Context,
+  Context as OpenTelemetryContext,
   Span,
   SpanStatusCode,
   trace,
@@ -14,7 +15,6 @@ import type {
   EmbedOnFinishEvent,
   EmbedOnStartEvent,
   EmbedStartEvent,
-  GenerationContext,
   ObjectOnFinishEvent,
   ObjectOnStartEvent,
   ObjectOnStepFinishEvent,
@@ -32,7 +32,7 @@ import type {
   RerankOnStartEvent,
   RerankStartEvent,
   TelemetryIntegration,
-  TelemetrySettings,
+  TelemetryOptions,
   ToolSet,
 } from 'ai';
 import { assembleOperationName } from './assemble-operation-name';
@@ -56,13 +56,13 @@ function recordSpanError(span: Span, error: unknown): void {
 }
 
 function shouldRecord(
-  telemetry: TelemetrySettings | undefined,
-): telemetry is TelemetrySettings {
-  return telemetry?.isEnabled === true;
+  telemetry: TelemetryOptions | undefined,
+): telemetry is TelemetryOptions {
+  return telemetry?.isEnabled !== false;
 }
 
 function selectAttributes(
-  telemetry: TelemetrySettings | undefined,
+  telemetry: TelemetryOptions | undefined,
   attributes: Record<
     string,
     | AttributeValue
@@ -110,9 +110,9 @@ function selectAttributes(
 
 interface OtelStepStartEvent<
   TOOLS extends ToolSet = ToolSet,
-  CONTEXT extends GenerationContext<TOOLS> = GenerationContext<TOOLS>,
+  RUNTIME_CONTEXT extends AISDKContext = AISDKContext,
   OUTPUT extends Output = Output,
-> extends OnStepStartEvent<TOOLS, CONTEXT, OUTPUT> {
+> extends OnStepStartEvent<TOOLS, RUNTIME_CONTEXT, OUTPUT> {
   readonly promptMessages?: LanguageModelV4Prompt;
   readonly stepTools?: ReadonlyArray<Record<string, unknown>>;
   readonly stepToolChoice?: unknown;
@@ -120,14 +120,14 @@ interface OtelStepStartEvent<
 
 interface CallState {
   operationId: string;
-  telemetry: TelemetrySettings | undefined;
+  telemetry: TelemetryOptions | undefined;
   rootSpan: Span | undefined;
-  rootContext: Context | undefined;
+  rootContext: OpenTelemetryContext | undefined;
   stepSpan: Span | undefined;
-  stepContext: Context | undefined;
-  embedSpans: Map<string, { span: Span; context: Context }>;
-  rerankSpan: { span: Span; context: Context } | undefined;
-  toolSpans: Map<string, { span: Span; context: Context }>;
+  stepContext: OpenTelemetryContext | undefined;
+  embedSpans: Map<string, { span: Span; context: OpenTelemetryContext }>;
+  rerankSpan: { span: Span; context: OpenTelemetryContext } | undefined;
+  toolSpans: Map<string, { span: Span; context: OpenTelemetryContext }>;
   baseTelemetryAttributes: Attributes;
   settings: Record<string, unknown>;
 }
@@ -176,12 +176,12 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
 
   onStart(
     event:
-      | OnStartEvent<ToolSet, Output>
+      | OnStartEvent
       | ObjectOnStartEvent
       | EmbedOnStartEvent
       | RerankOnStartEvent,
   ): void {
-    if (event.isEnabled !== true) return;
+    if (event.isEnabled === false) return;
 
     if (
       event.operationId === 'ai.embed' ||
@@ -204,16 +204,15 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
       return;
     }
 
-    this.onGenerateStart(event as OnStartEvent<ToolSet, Output>);
+    this.onGenerateStart(event as OnStartEvent);
   }
 
-  private onGenerateStart(event: OnStartEvent<ToolSet, Output>): void {
-    const telemetry: TelemetrySettings = {
+  private onGenerateStart(event: OnStartEvent): void {
+    const telemetry: TelemetryOptions = {
       isEnabled: event.isEnabled,
       recordInputs: event.recordInputs,
       recordOutputs: event.recordOutputs,
       functionId: event.functionId,
-      metadata: event.metadata,
     };
 
     const settings: Record<string, unknown> = {
@@ -230,9 +229,9 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
 
     const baseTelemetryAttributes = getBaseTelemetryAttributes({
       model: { provider: event.provider, modelId: event.modelId },
-      telemetry,
       headers: event.headers,
       settings,
+      context: event.runtimeContext as Record<string, unknown> | undefined,
     });
 
     const attributes = selectAttributes(telemetry, {
@@ -272,12 +271,11 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
   }
 
   private onObjectOperationStart(event: ObjectOnStartEvent): void {
-    const telemetry: TelemetrySettings = {
+    const telemetry: TelemetryOptions = {
       isEnabled: event.isEnabled,
       recordInputs: event.recordInputs,
       recordOutputs: event.recordOutputs,
       functionId: event.functionId,
-      metadata: event.metadata,
     };
 
     const settings: Record<string, unknown> = {
@@ -293,9 +291,9 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
 
     const baseTelemetryAttributes = getBaseTelemetryAttributes({
       model: { provider: event.provider, modelId: event.modelId },
-      telemetry,
       headers: event.headers,
       settings,
+      context: undefined,
     });
 
     const attributes = selectAttributes(telemetry, {
@@ -444,12 +442,11 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
   }
 
   private onEmbedOperationStart(event: EmbedOnStartEvent): void {
-    const telemetry: TelemetrySettings = {
+    const telemetry: TelemetryOptions = {
       isEnabled: event.isEnabled,
       recordInputs: event.recordInputs,
       recordOutputs: event.recordOutputs,
       functionId: event.functionId,
-      metadata: event.metadata,
     };
 
     const settings: Record<string, unknown> = {
@@ -458,9 +455,9 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
 
     const baseTelemetryAttributes = getBaseTelemetryAttributes({
       model: { provider: event.provider, modelId: event.modelId },
-      telemetry,
       headers: event.headers,
       settings,
+      context: undefined,
     });
 
     const value = event.value;
@@ -503,7 +500,7 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
     });
   }
 
-  onStepStart(event: OtelStepStartEvent<ToolSet, Output>): void {
+  onStepStart(event: OtelStepStartEvent): void {
     const state = this.getCallState(event.callId);
     if (!state?.rootSpan || !state.rootContext) return;
 
@@ -619,7 +616,7 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
             },
           }),
         );
-      } catch (_ignored) {
+      } catch {
         // JSON.stringify might fail for non-serializable results
       }
     } else {
@@ -929,12 +926,11 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
   }
 
   private onRerankOperationStart(event: RerankOnStartEvent): void {
-    const telemetry: TelemetrySettings = {
+    const telemetry: TelemetryOptions = {
       isEnabled: event.isEnabled,
       recordInputs: event.recordInputs,
       recordOutputs: event.recordOutputs,
       functionId: event.functionId,
-      metadata: event.metadata,
     };
 
     const settings: Record<string, unknown> = {
@@ -943,9 +939,9 @@ export class OpenTelemetryIntegration implements TelemetryIntegration {
 
     const baseTelemetryAttributes = getBaseTelemetryAttributes({
       model: { provider: event.provider, modelId: event.modelId },
-      telemetry,
       headers: event.headers,
       settings,
+      context: undefined,
     });
 
     const attributes = selectAttributes(telemetry, {

package/src/select-telemetry-attributes.ts

@@ -1,5 +1,5 @@
 import type { Attributes, AttributeValue } from '@opentelemetry/api';
-import type { TelemetrySettings } from 'ai';
+import type { TelemetryOptions } from 'ai';
 
 type ResolvableAttributeValue = () =>
   | AttributeValue
@@ -10,7 +10,7 @@ export async function selectTelemetryAttributes({
   telemetry,
   attributes,
 }: {
-  telemetry?: TelemetrySettings;
+  telemetry?: TelemetryOptions;
   attributes: {
     [attributeKey: string]:
       | AttributeValue
@@ -20,7 +20,7 @@ export async function selectTelemetryAttributes({
   };
 }): Promise<Attributes> {
   // when telemetry is disabled, return an empty object to avoid serialization overhead:
-  if (telemetry?.isEnabled !== true) {
+  if (telemetry?.isEnabled === false) {
     return {};
   }
 

package/dist/index.d.mts

@@ -1,52 +0,0 @@
-import { LanguageModelV4Prompt } from '@ai-sdk/provider';
-import { Tracer } from '@opentelemetry/api';
-import { TelemetryIntegration, OnStartEvent, ToolSet, OutputInterface, ObjectOnStartEvent, EmbedOnStartEvent, RerankOnStartEvent, ObjectOnStepStartEvent, ObjectOnStepFinishEvent, GenerationContext, OnStepStartEvent, OnToolCallStartEvent, OnToolCallFinishEvent, OnStepFinishEvent, OnFinishEvent, ObjectOnFinishEvent, EmbedOnFinishEvent, RerankOnFinishEvent, EmbedStartEvent, EmbedFinishEvent, RerankStartEvent, RerankFinishEvent, OnChunkEvent } from 'ai';
-
-interface OtelStepStartEvent<TOOLS extends ToolSet = ToolSet, CONTEXT extends GenerationContext<TOOLS> = GenerationContext<TOOLS>, OUTPUT extends OutputInterface = OutputInterface> extends OnStepStartEvent<TOOLS, CONTEXT, OUTPUT> {
-    readonly promptMessages?: LanguageModelV4Prompt;
-    readonly stepTools?: ReadonlyArray<Record<string, unknown>>;
-    readonly stepToolChoice?: unknown;
-}
-declare class OpenTelemetryIntegration implements TelemetryIntegration {
-    private readonly callStates;
-    /**
-     * The tracer to use for the telemetry data.
-     */
-    private readonly tracer;
-    constructor(options?: {
-        tracer?: Tracer;
-    });
-    private getCallState;
-    private cleanupCallState;
-    executeTool<T>({ callId, toolCallId, execute, }: {
-        callId: string;
-        toolCallId: string;
-        execute: () => PromiseLike<T>;
-    }): PromiseLike<T>;
-    onStart(event: OnStartEvent<ToolSet, OutputInterface> | ObjectOnStartEvent | EmbedOnStartEvent | RerankOnStartEvent): void;
-    private onGenerateStart;
-    private onObjectOperationStart;
-    /** @deprecated */
-    onObjectStepStart(event: ObjectOnStepStartEvent): void;
-    /** @deprecated */
-    onObjectStepFinish(event: ObjectOnStepFinishEvent): void;
-    private onEmbedOperationStart;
-    onStepStart(event: OtelStepStartEvent<ToolSet, OutputInterface>): void;
-    onToolCallStart(event: OnToolCallStartEvent<ToolSet>): void;
-    onToolCallFinish(event: OnToolCallFinishEvent<ToolSet>): void;
-    onStepFinish(event: OnStepFinishEvent<ToolSet>): void;
-    onFinish(event: OnFinishEvent<ToolSet> | ObjectOnFinishEvent<unknown> | EmbedOnFinishEvent | RerankOnFinishEvent): void;
-    private onGenerateFinish;
-    private onObjectOperationFinish;
-    private onEmbedOperationFinish;
-    onEmbedStart(event: EmbedStartEvent): void;
-    onEmbedFinish(event: EmbedFinishEvent): void;
-    private onRerankOperationStart;
-    private onRerankOperationFinish;
-    onRerankStart(event: RerankStartEvent): void;
-    onRerankFinish(event: RerankFinishEvent): void;
-    onChunk(event: OnChunkEvent<ToolSet>): void;
-    onError(error: unknown): void;
-}
-
-export { OpenTelemetryIntegration };