@ai-sdk/otel 1.0.0-canary.99 → 1.0.0

package/dist/index.js

@@ -467,6 +467,39 @@ function recordErrorOnSpan(span, error) {
   }
 }
 
+// src/sanitize-attribute-value.ts
+function isPrimitiveAttributeValue(value) {
+  return typeof value === "string" || typeof value === "number" || typeof value === "boolean";
+}
+function sanitizeAttributeValue(value) {
+  if (!Array.isArray(value)) {
+    return value;
+  }
+  const primitiveTypes = new Set(
+    value.filter(isPrimitiveAttributeValue).map((item) => typeof item)
+  );
+  if (primitiveTypes.size !== 1) {
+    return void 0;
+  }
+  const [primitiveType] = primitiveTypes;
+  if (primitiveType === "string") {
+    return value.filter((item) => typeof item === "string");
+  }
+  if (primitiveType === "number") {
+    return value.filter((item) => typeof item === "number");
+  }
+  return value.filter((item) => typeof item === "boolean");
+}
+function sanitizeAttributes(attributes) {
+  const result = {};
+  for (const [key, value] of Object.entries(attributes != null ? attributes : {})) {
+    if (value == null) continue;
+    const sanitized = sanitizeAttributeValue(value);
+    if (sanitized != null) result[key] = sanitized;
+  }
+  return result;
+}
+
 // src/select-attributes.ts
 function shouldRecord(telemetry) {
   return (telemetry == null ? void 0 : telemetry.isEnabled) !== false;
@@ -481,16 +514,23 @@ function selectAttributes(telemetry, attributes) {
     if (typeof value === "object" && "input" in value && typeof value.input === "function") {
       if ((telemetry == null ? void 0 : telemetry.recordInputs) === false) continue;
       const resolved = value.input();
-      if (resolved != null) result[key] = resolved;
+      if (resolved != null) {
+        const sanitized2 = sanitizeAttributeValue(resolved);
+        if (sanitized2 != null) result[key] = sanitized2;
+      }
       continue;
     }
     if (typeof value === "object" && "output" in value && typeof value.output === "function") {
       if ((telemetry == null ? void 0 : telemetry.recordOutputs) === false) continue;
       const resolved = value.output();
-      if (resolved != null) result[key] = resolved;
+      if (resolved != null) {
+        const sanitized2 = sanitizeAttributeValue(resolved);
+        if (sanitized2 != null) result[key] = sanitized2;
+      }
       continue;
     }
-    result[key] = value;
+    const sanitized = sanitizeAttributeValue(value);
+    if (sanitized != null) result[key] = sanitized;
   }
   return result;
 }
@@ -521,9 +561,23 @@ function normalizeSupplementalAttributes(options) {
   };
 }
 function getRuntimeContextAttributes(context4) {
-  return Object.fromEntries(
-    Object.entries(context4 != null ? context4 : {}).filter(([, value]) => value != null).map(([key, value]) => [`ai.settings.context.${key}`, value])
-  );
+  const attributes = {};
+  for (const [key, value] of Object.entries(context4 != null ? context4 : {})) {
+    addRuntimeContextAttribute(attributes, `ai.settings.context.${key}`, value);
+  }
+  return attributes;
+}
+function addRuntimeContextAttribute(attributes, key, value) {
+  if (value == null) {
+    return;
+  }
+  if (Array.isArray(value) || typeof value !== "object") {
+    attributes[key] = value;
+    return;
+  }
+  for (const [nestedKey, nestedValue] of Object.entries(value)) {
+    addRuntimeContextAttribute(attributes, `${key}.${nestedKey}`, nestedValue);
+  }
 }
 function getHeaderAttributes(headers) {
   return Object.fromEntries(
@@ -550,6 +604,21 @@ function selectSupplementalAttributes(telemetry, enabledAttributes, attributes)
 }
 
 // src/open-telemetry.ts
+function msToSeconds(durationMs) {
+  return durationMs == null ? void 0 : durationMs / 1e3;
+}
+function getGenAIClientPerformanceAttributes(performance) {
+  var _a;
+  return {
+    "gen_ai.client.operation.duration": msToSeconds(performance.responseTimeMs),
+    "gen_ai.client.operation.time_to_first_chunk": msToSeconds(
+      performance.timeToFirstOutputMs
+    ),
+    "gen_ai.client.operation.time_per_output_chunk": msToSeconds(
+      (_a = performance.timeBetweenOutputChunksMs) == null ? void 0 : _a.avg
+    )
+  };
+}
 var OpenTelemetry = class {
   constructor(options = {}) {
     this.callStates = /* @__PURE__ */ new Map();
@@ -584,7 +653,7 @@ var OpenTelemetry = class {
       customAttributes = void 0;
     }
     return {
-      ...customAttributes,
+      ...sanitizeAttributes(customAttributes),
       ...attributes
     };
   }
@@ -600,6 +669,22 @@ var OpenTelemetry = class {
     }
     return context2.with(toolSpanEntry.context, execute);
   }
+  /**
+   * Runs the provider `doGenerate`/`doStream` call with the active model-call
+   * context.
+   */
+  executeLanguageModelCall({
+    callId,
+    execute
+  }) {
+    var _a;
+    const state = this.getCallState(callId);
+    const modelCallContext = (_a = state == null ? void 0 : state.inferenceContext) != null ? _a : state == null ? void 0 : state.stepContext;
+    if (modelCallContext == null) {
+      return execute();
+    }
+    return context2.with(modelCallContext, execute);
+  }
   onStart(event) {
     if (event.operationId === "ai.embed" || event.operationId === "ai.embedMany") {
       this.onEmbedOperationStart(event);
@@ -840,7 +925,7 @@ var OpenTelemetry = class {
     );
   }
   /** @deprecated */
-  onObjectStepFinish(event) {
+  onObjectStepEnd(event) {
     var _a;
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.inferenceSpan)) return;
@@ -1035,6 +1120,7 @@ var OpenTelemetry = class {
     const { telemetry } = state;
     state.inferenceSpan.setAttributes(
       selectAttributes(telemetry, {
+        ...getGenAIClientPerformanceAttributes(event.performance),
         "gen_ai.response.finish_reasons": [event.finishReason],
         "gen_ai.response.id": event.responseId,
         "gen_ai.usage.input_tokens": event.usage.inputTokens,
@@ -1108,6 +1194,11 @@ var OpenTelemetry = class {
     const { span } = toolSpanEntry;
     const { telemetry } = state;
     const { toolOutput } = event;
+    span.setAttributes(
+      selectAttributes(telemetry, {
+        "gen_ai.execute_tool.duration": msToSeconds(event.toolExecutionMs)
+      })
+    );
     if (toolOutput.type === "tool-result") {
       try {
         span.setAttributes(
@@ -1125,7 +1216,7 @@ var OpenTelemetry = class {
     span.end();
     state.toolSpans.delete(event.toolCall.toolCallId);
   }
-  onStepFinish(event) {
+  onStepEnd(event) {
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.stepSpan)) return;
     const { telemetry } = state;
@@ -1141,6 +1232,10 @@ var OpenTelemetry = class {
     state.stepSpan = void 0;
     state.stepContext = void 0;
   }
+  /** @deprecated Use `onStepEnd` instead. */
+  onStepFinish(event) {
+    this.onStepEnd(event);
+  }
   onEnd(event) {
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.rootSpan)) return;
@@ -1166,17 +1261,17 @@ var OpenTelemetry = class {
     state.rootSpan.setAttributes(
       selectAttributes(telemetry, {
         "gen_ai.response.finish_reasons": [event.finishReason],
-        "gen_ai.usage.input_tokens": event.totalUsage.inputTokens,
-        "gen_ai.usage.output_tokens": event.totalUsage.outputTokens,
-        "gen_ai.usage.cache_read.input_tokens": (_a = event.totalUsage.inputTokenDetails) == null ? void 0 : _a.cacheReadTokens,
-        "gen_ai.usage.cache_creation.input_tokens": (_b = event.totalUsage.inputTokenDetails) == null ? void 0 : _b.cacheWriteTokens,
+        "gen_ai.usage.input_tokens": event.usage.inputTokens,
+        "gen_ai.usage.output_tokens": event.usage.outputTokens,
+        "gen_ai.usage.cache_read.input_tokens": (_a = event.usage.inputTokenDetails) == null ? void 0 : _a.cacheReadTokens,
+        "gen_ai.usage.cache_creation.input_tokens": (_b = event.usage.inputTokenDetails) == null ? void 0 : _b.cacheWriteTokens,
         "gen_ai.output.messages": {
           output: () => {
             var _a2;
             return JSON.stringify(
               formatOutputMessages({
                 text: (_a2 = event.text) != null ? _a2 : void 0,
-                reasoning: event.reasoning,
+                reasoning: event.finalStep.reasoning,
                 toolCalls: event.toolCalls,
                 files: event.files,
                 finishReason: event.finishReason
@@ -1189,9 +1284,9 @@ var OpenTelemetry = class {
           this.supplementalAttributes,
           {
             providerMetadata: {
-              "ai.response.providerMetadata": event.providerMetadata ? JSON.stringify(event.providerMetadata) : void 0
+              "ai.response.providerMetadata": event.finalStep.providerMetadata ? JSON.stringify(event.finalStep.providerMetadata) : void 0
             },
-            usage: getDetailedUsageAttributes(event.totalUsage)
+            usage: getDetailedUsageAttributes(event.usage)
           }
         )
       })
@@ -1446,6 +1541,34 @@ var OpenTelemetry = class {
     span.end();
     state.rerankSpan = void 0;
   }
+  onAbort(event) {
+    const state = this.getCallState(event.callId);
+    if (!(state == null ? void 0 : state.rootSpan)) return;
+    for (const { span: toolSpan } of state.toolSpans.values()) {
+      toolSpan.end();
+    }
+    state.toolSpans.clear();
+    if (state.inferenceSpan) {
+      state.inferenceSpan.end();
+      state.inferenceSpan = void 0;
+      state.inferenceContext = void 0;
+    }
+    if (state.stepSpan) {
+      state.stepSpan.end();
+      state.stepSpan = void 0;
+      state.stepContext = void 0;
+    }
+    for (const { span: embedSpan } of state.embedSpans.values()) {
+      embedSpan.end();
+    }
+    state.embedSpans.clear();
+    if (state.rerankSpan) {
+      state.rerankSpan.span.end();
+      state.rerankSpan = void 0;
+    }
+    state.rootSpan.end();
+    this.cleanupCallState(event.callId);
+  }
   onError(error) {
     var _a;
     const event = error;
@@ -1524,12 +1647,7 @@ function getBaseTelemetryAttributes({
       return attributes;
     }, {}),
     // add context as attributes:
-    ...Object.entries(context4 != null ? context4 : {}).reduce((attributes, [key, value]) => {
-      if (value != void 0) {
-        attributes[`ai.settings.context.${key}`] = value;
-      }
-      return attributes;
-    }, {}),
+    ...getRuntimeContextAttributes(context4),
     // request headers
     ...Object.entries(headers != null ? headers : {}).reduce((attributes, [key, value]) => {
       if (value !== void 0) {
@@ -1597,16 +1715,23 @@ function selectAttributes2(telemetry, attributes) {
     if (typeof value === "object" && "input" in value && typeof value.input === "function") {
       if ((telemetry == null ? void 0 : telemetry.recordInputs) === false) continue;
       const resolved = value.input();
-      if (resolved != null) result[key] = resolved;
+      if (resolved != null) {
+        const sanitized2 = sanitizeAttributeValue(resolved);
+        if (sanitized2 != null) result[key] = sanitized2;
+      }
       continue;
     }
     if (typeof value === "object" && "output" in value && typeof value.output === "function") {
       if ((telemetry == null ? void 0 : telemetry.recordOutputs) === false) continue;
       const resolved = value.output();
-      if (resolved != null) result[key] = resolved;
+      if (resolved != null) {
+        const sanitized2 = sanitizeAttributeValue(resolved);
+        if (sanitized2 != null) result[key] = sanitized2;
+      }
       continue;
     }
-    result[key] = value;
+    const sanitized = sanitizeAttributeValue(value);
+    if (sanitized != null) result[key] = sanitized;
   }
   return result;
 }
@@ -1634,6 +1759,21 @@ var LegacyOpenTelemetry = class {
     }
     return context3.with(toolSpanEntry.context, execute);
   }
+  /**
+   * Runs the provider `doGenerate`/`doStream` call with the active legacy
+   * model-call context.
+   */
+  executeLanguageModelCall({
+    callId,
+    execute
+  }) {
+    var _a;
+    const stepContext = (_a = this.getCallState(callId)) == null ? void 0 : _a.stepContext;
+    if (stepContext == null) {
+      return execute();
+    }
+    return context3.with(stepContext, execute);
+  }
   onStart(event) {
     if (event.operationId === "ai.embed" || event.operationId === "ai.embedMany") {
       this.onEmbedOperationStart(event);
@@ -1796,7 +1936,7 @@ var LegacyOpenTelemetry = class {
     state.stepContext = trace2.setSpan(state.rootContext, state.stepSpan);
   }
   /** @deprecated */
-  onObjectStepFinish(event) {
+  onObjectStepEnd(event) {
     var _a, _b;
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.stepSpan)) return;
@@ -1985,7 +2125,7 @@ var LegacyOpenTelemetry = class {
     span.end();
     state.toolSpans.delete(event.toolCall.toolCallId);
   }
-  onStepFinish(event) {
+  onStepEnd(event) {
     var _a, _b, _c, _d, _e, _f, _g;
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.stepSpan)) return;
@@ -2025,7 +2165,7 @@ var LegacyOpenTelemetry = class {
         "ai.response.model": event.response.modelId,
         "ai.response.timestamp": event.response.timestamp.toISOString(),
         "ai.response.providerMetadata": event.providerMetadata ? JSON.stringify(event.providerMetadata) : void 0,
-        "ai.response.msToFirstChunk": isStreamText ? event.performance.timeToFirstOutputTokenMs : void 0,
+        "ai.response.msToFirstChunk": isStreamText ? event.performance.timeToFirstOutputMs : void 0,
         "ai.response.msToFinish": isStreamText ? event.performance.responseTimeMs : void 0,
         "ai.response.avgOutputTokensPerSecond": isStreamText ? event.performance.effectiveOutputTokensPerSecond : void 0,
         "ai.usage.inputTokens": event.usage.inputTokens,
@@ -2045,9 +2185,9 @@ var LegacyOpenTelemetry = class {
         "gen_ai.usage.output_tokens": event.usage.outputTokens
       })
     );
-    if (isStreamText && event.performance.timeToFirstOutputTokenMs != null) {
+    if (isStreamText && event.performance.timeToFirstOutputMs != null) {
       state.stepSpan.addEvent("ai.stream.firstChunk", {
-        "ai.response.msToFirstChunk": event.performance.timeToFirstOutputTokenMs
+        "ai.response.msToFirstChunk": event.performance.timeToFirstOutputMs
       });
     }
     if (isStreamText) {
@@ -2060,6 +2200,10 @@ var LegacyOpenTelemetry = class {
     state.stepSpan = void 0;
     state.stepContext = void 0;
   }
+  /** @deprecated Use `onStepEnd` instead. */
+  onStepFinish(event) {
+    this.onStepEnd(event);
+  }
   onEnd(event) {
     const state = this.getCallState(event.callId);
     if (!(state == null ? void 0 : state.rootSpan)) return;
@@ -2092,7 +2236,7 @@ var LegacyOpenTelemetry = class {
           }
         },
         "ai.response.reasoning": {
-          output: () => event.reasoning.length > 0 ? event.reasoning.filter((part) => "text" in part).map((part) => part.text).join("\n") : void 0
+          output: () => event.finalStep.reasoning.length > 0 ? event.finalStep.reasoning.filter((part) => "text" in part).map((part) => part.text).join("\n") : void 0
         },
         "ai.response.toolCalls": {
           output: () => event.toolCalls.length > 0 ? JSON.stringify(
@@ -2112,17 +2256,17 @@ var LegacyOpenTelemetry = class {
             }))
           ) : void 0
         },
-        "ai.response.providerMetadata": event.providerMetadata ? JSON.stringify(event.providerMetadata) : void 0,
-        "ai.usage.inputTokens": event.totalUsage.inputTokens,
-        "ai.usage.outputTokens": event.totalUsage.outputTokens,
-        "ai.usage.totalTokens": event.totalUsage.totalTokens,
-        "ai.usage.reasoningTokens": (_a = event.totalUsage.outputTokenDetails) == null ? void 0 : _a.reasoningTokens,
-        "ai.usage.cachedInputTokens": (_b = event.totalUsage.inputTokenDetails) == null ? void 0 : _b.cacheReadTokens,
-        "ai.usage.inputTokenDetails.noCacheTokens": (_c = event.totalUsage.inputTokenDetails) == null ? void 0 : _c.noCacheTokens,
-        "ai.usage.inputTokenDetails.cacheReadTokens": (_d = event.totalUsage.inputTokenDetails) == null ? void 0 : _d.cacheReadTokens,
-        "ai.usage.inputTokenDetails.cacheWriteTokens": (_e = event.totalUsage.inputTokenDetails) == null ? void 0 : _e.cacheWriteTokens,
-        "ai.usage.outputTokenDetails.textTokens": (_f = event.totalUsage.outputTokenDetails) == null ? void 0 : _f.textTokens,
-        "ai.usage.outputTokenDetails.reasoningTokens": (_g = event.totalUsage.outputTokenDetails) == null ? void 0 : _g.reasoningTokens
+        "ai.response.providerMetadata": event.finalStep.providerMetadata ? JSON.stringify(event.finalStep.providerMetadata) : void 0,
+        "ai.usage.inputTokens": event.usage.inputTokens,
+        "ai.usage.outputTokens": event.usage.outputTokens,
+        "ai.usage.totalTokens": event.usage.totalTokens,
+        "ai.usage.reasoningTokens": (_a = event.usage.outputTokenDetails) == null ? void 0 : _a.reasoningTokens,
+        "ai.usage.cachedInputTokens": (_b = event.usage.inputTokenDetails) == null ? void 0 : _b.cacheReadTokens,
+        "ai.usage.inputTokenDetails.noCacheTokens": (_c = event.usage.inputTokenDetails) == null ? void 0 : _c.noCacheTokens,
+        "ai.usage.inputTokenDetails.cacheReadTokens": (_d = event.usage.inputTokenDetails) == null ? void 0 : _d.cacheReadTokens,
+        "ai.usage.inputTokenDetails.cacheWriteTokens": (_e = event.usage.inputTokenDetails) == null ? void 0 : _e.cacheWriteTokens,
+        "ai.usage.outputTokenDetails.textTokens": (_f = event.usage.outputTokenDetails) == null ? void 0 : _f.textTokens,
+        "ai.usage.outputTokenDetails.reasoningTokens": (_g = event.usage.outputTokenDetails) == null ? void 0 : _g.reasoningTokens
       })
     );
     state.rootSpan.end();
@@ -2300,6 +2444,29 @@ var LegacyOpenTelemetry = class {
     span.end();
     state.rerankSpan = void 0;
   }
+  onAbort(event) {
+    const state = this.getCallState(event.callId);
+    if (!(state == null ? void 0 : state.rootSpan)) return;
+    for (const { span: toolSpan } of state.toolSpans.values()) {
+      toolSpan.end();
+    }
+    state.toolSpans.clear();
+    if (state.stepSpan) {
+      state.stepSpan.end();
+      state.stepSpan = void 0;
+      state.stepContext = void 0;
+    }
+    for (const { span: embedSpan } of state.embedSpans.values()) {
+      embedSpan.end();
+    }
+    state.embedSpans.clear();
+    if (state.rerankSpan) {
+      state.rerankSpan.span.end();
+      state.rerankSpan = void 0;
+    }
+    state.rootSpan.end();
+    this.cleanupCallState(event.callId);
+  }
   onError(error) {
     var _a;
     const event = error;