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

package/CHANGELOG.md

@@ -1,5 +1,311 @@
 # @ai-sdk/otel
 
+## 1.0.0
+
+### Major Changes
+
+- 6542d93: feat(ai): change naming nomenclature for `*TelemetryIntegration` to `*Telemetry`
+- cf93359: feat(ai): remove/refactor event data sent via callbacks
+- 8284dfa: feat(otel): rename OpenTelemetry to LegacyOpenTelemetry
+- ef992f8: Remove CommonJS exports from all packages. All packages are now ESM-only (`"type": "module"`). Consumers using `require()` must switch to ESM `import` syntax.
+- 116c89f: feat(ai): remove telemetry data from the user-facing event data
+- b3c9f6a: feat(ai): create new opentelemetry package (@ai-sdk/otel)
+
+### Patch Changes
+
+- b94d22f: Sanitize OpenTelemetry span array attributes so they no longer emit invalid OTLP values (arrays containing `undefined`/`null`/objects, or arrays mixing primitive types). Such values previously failed telemetry ingestion with `deserializing message invalid value: map, expected map with a single key` and flooded function logs with errors.
+- 19736ee: feat(ai): rename onStepFinish to onStepEnd
+- 4757690: feat(ai): rename onObjectStepFinish to onObjectStepEnd
+- 382d53b: refactoring: rename context to runtimeContext
+- 7bf7d7f: feat(ai): enable:true for telemetry by default
+- c025d60: feat(otel): add option for custom span attributes
+- 1db29c8: feat(ai): break `CallSettings` apart into `LanguageModelCallOptions` and `RequestOptions`
+- eea8d98: refactoring: rename tool execution events
+- 5d0f18e: feat(ai): move opentelemetry to new package
+- 1582efa: chore(ai): remove the metadata field from the telemetry settings
+- 98627e5: feat(ai): remove onChunk event from telemetry
+- 9f0e36c: trigger release for all packages after provenance setup
+- 1e200eb: fix(otel): ensure nested context object creates separate attribute
+- 29d8cf4: feat(ai): rename the core-event types
+- 18651f6: feat(otel): add opt-in options for supplemental AI SDK attributes on OpenTelemetry spans
+- e4182bd: chore: rm export of OutputInterface
+- 1043274: feat(ai): add a ModelCall start/end event
+- 476e1ca: feat(ai): remove telemetry dependency on onChunk callback
+- 7fc6bd6: Raise minimum supported Node.js version to 22. Supported versions: 22, 24, and 26.
+- 594029e: feat(ai): wrap the model call in telemetry context
+- eaf849f: Rename rerank telemetry finish callback to `onRerankEnd`.
+- 0c4c275: trigger initial canary release
+- fc15550: feat(otel): add the genAI semantic otel integration
+- 9bd6512: feat(provider): change file part data property to be tagged with a type and remove the image part type
+- 258c093: chore: ensure consistent import handling and avoid import duplicates or cycles
+- 8565dcb: fix: rename onEmbedFinish to onEmbedEnd
+- 152c67c: feat(otel): add a step level span
+- e1bfb9c: feat(ai): remove unnecessary data from events
+- 334ae5d: Update step performance metrics with explicit effective, input, output, and total token throughput fields.
+- b8396f0: trigger initial beta release
+- d5cac7c: feat(otel): emit performance metrics via gen ai semantics
+- c3d4019: chore(ai): rename 'TelemetrySettings' to 'TelemetryOptions'
+- e92fc45: feat(ai): introduce onAbort hook to close telemetry spans
+- 083947b: feat(ai): separate toolsContext from context
+- 64de016: feat(otel): rename GenAIOpenTelemetry to OpenTelemetry
+- 90e2d8a: chore: fix unused vars not being flagged by our lint tooling
+
+## 1.0.0-beta.133
+
+### Patch Changes
+
+- ai@7.0.0-beta.187
+
+## 1.0.0-beta.132
+
+### Patch Changes
+
+- ai@7.0.0-beta.186
+
+## 1.0.0-beta.131
+
+### Patch Changes
+
+- Updated dependencies [75763b0]
+  - ai@7.0.0-beta.185
+
+## 1.0.0-beta.130
+
+### Patch Changes
+
+- b94d22f: Sanitize OpenTelemetry span array attributes so they no longer emit invalid OTLP values (arrays containing `undefined`/`null`/objects, or arrays mixing primitive types). Such values previously failed telemetry ingestion with `deserializing message invalid value: map, expected map with a single key` and flooded function logs with errors.
+- d5cac7c: feat(otel): emit performance metrics via gen ai semantics
+- Updated dependencies [0416e3e]
+  - @ai-sdk/provider@4.0.0-beta.20
+  - ai@7.0.0-beta.184
+
+## 1.0.0-beta.129
+
+### Patch Changes
+
+- ai@7.0.0-beta.183
+
+## 1.0.0-beta.128
+
+### Patch Changes
+
+- Updated dependencies [cc6ab90]
+  - ai@7.0.0-beta.182
+
+## 1.0.0-beta.127
+
+### Patch Changes
+
+- Updated dependencies [6a2caf9]
+  - ai@7.0.0-beta.181
+
+## 1.0.0-beta.126
+
+### Patch Changes
+
+- Updated dependencies [81a284b]
+  - ai@7.0.0-beta.180
+
+## 1.0.0-beta.125
+
+### Patch Changes
+
+- ai@7.0.0-beta.179
+
+## 1.0.0-beta.124
+
+### Patch Changes
+
+- Updated dependencies [b097c52]
+  - ai@7.0.0-beta.178
+
+## 1.0.0-beta.123
+
+### Patch Changes
+
+- b8396f0: trigger initial beta release
+- Updated dependencies [b8396f0]
+  - @ai-sdk/provider@4.0.0-beta.19
+  - ai@7.0.0-beta.177
+
+## 1.0.0-canary.122
+
+### Patch Changes
+
+- ai@7.0.0-canary.176
+
+## 1.0.0-canary.121
+
+### Patch Changes
+
+- Updated dependencies [6ec57f5]
+  - ai@7.0.0-canary.175
+
+## 1.0.0-canary.120
+
+### Patch Changes
+
+- ai@7.0.0-canary.174
+
+## 1.0.0-canary.119
+
+### Patch Changes
+
+- ai@7.0.0-canary.173
+
+## 1.0.0-canary.118
+
+### Patch Changes
+
+- Updated dependencies [25a64f8]
+- Updated dependencies [375fdd7]
+- Updated dependencies [f18b08f]
+- Updated dependencies [b4507d5]
+  - ai@7.0.0-canary.172
+
+## 1.0.0-canary.117
+
+### Patch Changes
+
+- Updated dependencies [89ad56f]
+- Updated dependencies [f9a496f]
+- Updated dependencies [3295831]
+  - ai@7.0.0-canary.171
+
+## 1.0.0-canary.116
+
+### Patch Changes
+
+- Updated dependencies [bae5e2b]
+- Updated dependencies [69d7128]
+  - ai@7.0.0-canary.170
+
+## 1.0.0-canary.115
+
+### Patch Changes
+
+- Updated dependencies [a5018ab]
+- Updated dependencies [21d3d60]
+- Updated dependencies [426dbbb]
+- Updated dependencies [7fd3360]
+  - ai@7.0.0-canary.169
+
+## 1.0.0-canary.114
+
+### Patch Changes
+
+- Updated dependencies [1e4b350]
+  - ai@7.0.0-canary.168
+
+## 1.0.0-canary.113
+
+### Patch Changes
+
+- 4757690: feat(ai): rename onObjectStepFinish to onObjectStepEnd
+- Updated dependencies [4757690]
+- Updated dependencies [eeefc3f]
+- Updated dependencies [b79b6a8]
+  - ai@7.0.0-canary.167
+
+## 1.0.0-canary.112
+
+### Patch Changes
+
+- 19736ee: feat(ai): rename onStepFinish to onStepEnd
+- e4182bd: chore: rm export of OutputInterface
+- Updated dependencies [19736ee]
+- Updated dependencies [d66ae02]
+- Updated dependencies [e4182bd]
+  - ai@7.0.0-canary.166
+
+## 1.0.0-canary.111
+
+### Patch Changes
+
+- Updated dependencies [ce769dd]
+  - @ai-sdk/provider@4.0.0-canary.18
+  - ai@7.0.0-canary.165
+
+## 1.0.0-canary.110
+
+### Patch Changes
+
+- ai@7.0.0-canary.164
+
+## 1.0.0-canary.109
+
+### Patch Changes
+
+- Updated dependencies [ee798eb]
+- Updated dependencies [c907622]
+  - ai@7.0.0-canary.163
+
+## 1.0.0-canary.108
+
+### Patch Changes
+
+- ai@7.0.0-canary.162
+
+## 1.0.0-canary.107
+
+### Patch Changes
+
+- ai@7.0.0-canary.161
+
+## 1.0.0-canary.106
+
+### Patch Changes
+
+- ai@7.0.0-canary.160
+
+## 1.0.0-canary.105
+
+### Patch Changes
+
+- Updated dependencies [b5092f5]
+  - ai@7.0.0-canary.159
+
+## 1.0.0-canary.104
+
+### Patch Changes
+
+- Updated dependencies [bcce2dd]
+  - ai@7.0.0-canary.158
+
+## 1.0.0-canary.103
+
+### Patch Changes
+
+- ai@7.0.0-canary.157
+
+## 1.0.0-canary.102
+
+### Patch Changes
+
+- 1e200eb: fix(otel): ensure nested context object creates separate attribute
+- e92fc45: feat(ai): introduce onAbort hook to close telemetry spans
+- Updated dependencies [023550e]
+- Updated dependencies [e92fc45]
+  - ai@7.0.0-canary.156
+
+## 1.0.0-canary.101
+
+### Patch Changes
+
+- Updated dependencies [e67d80e]
+- Updated dependencies [6cca112]
+- Updated dependencies [82fc0ab]
+- Updated dependencies [76fd58c]
+  - ai@7.0.0-canary.155
+
+## 1.0.0-canary.100
+
+### Patch Changes
+
+- 594029e: feat(ai): wrap the model call in telemetry context
+- Updated dependencies [594029e]
+  - ai@7.0.0-canary.154
+
 ## 1.0.0-canary.99
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Telemetry, InferTelemetryEvent, GenerateTextStartEvent, GenerateObjectStartEvent, EmbedStartEvent, RerankStartEvent, GenerateObjectStepStartEvent, GenerateObjectStepEndEvent, GenerateTextStepStartEvent, ToolSet, LanguageModelCallStartEvent, LanguageModelCallEndEvent, ToolExecutionStartEvent, ToolExecutionEndEvent, GenerateTextStepEndEvent, GenerateTextEndEvent, GenerateObjectEndEvent, EmbedEndEvent, RerankEndEvent, EmbeddingModelCallStartEvent, EmbeddingModelCallEndEvent, RerankingModelCallStartEvent, RerankingModelCallEndEvent, OutputInterface } from 'ai';
+import { Telemetry, InferTelemetryEvent, GenerateTextStartEvent, GenerateObjectStartEvent, EmbedStartEvent, RerankStartEvent, GenerateObjectStepStartEvent, GenerateObjectStepEndEvent, GenerateTextStepStartEvent, ToolSet, LanguageModelCallStartEvent, LanguageModelCallEndEvent, ToolExecutionStartEvent, ToolExecutionEndEvent, GenerateTextStepEndEvent, GenerateTextEndEvent, GenerateObjectEndEvent, EmbedEndEvent, RerankEndEvent, EmbeddingModelCallStartEvent, EmbeddingModelCallEndEvent, RerankingModelCallStartEvent, RerankingModelCallEndEvent, GenerateTextAbortEvent, Output } from 'ai';
 import { Attributes, Tracer } from '@opentelemetry/api';
 import { LanguageModelV4Prompt } from '@ai-sdk/provider';
 import { Context } from '@ai-sdk/provider-utils';
@@ -71,19 +71,29 @@ declare class OpenTelemetry implements Telemetry {
         toolCallId: string;
         execute: () => PromiseLike<T>;
     }): PromiseLike<T>;
+    /**
+     * Runs the provider `doGenerate`/`doStream` call with the active model-call
+     * context.
+     */
+    executeLanguageModelCall<T>({ callId, execute, }: {
+        callId: string;
+        execute: () => PromiseLike<T>;
+    }): PromiseLike<T>;
     onStart(event: InferTelemetryEvent<GenerateTextStartEvent> | InferTelemetryEvent<GenerateObjectStartEvent> | InferTelemetryEvent<EmbedStartEvent> | InferTelemetryEvent<RerankStartEvent>): void;
     private onGenerateStart;
     private onObjectOperationStart;
     /** @deprecated */
     onObjectStepStart(event: GenerateObjectStepStartEvent): void;
     /** @deprecated */
-    onObjectStepFinish(event: GenerateObjectStepEndEvent): void;
+    onObjectStepEnd(event: GenerateObjectStepEndEvent): void;
     private onEmbedOperationStart;
     onStepStart(event: OtelStepStartEvent$1): void;
     onLanguageModelCallStart(event: LanguageModelCallStartEvent): void;
     onLanguageModelCallEnd(event: LanguageModelCallEndEvent<ToolSet>): void;
     onToolExecutionStart(event: ToolExecutionStartEvent<ToolSet>): void;
     onToolExecutionEnd(event: ToolExecutionEndEvent<ToolSet>): void;
+    onStepEnd(event: GenerateTextStepEndEvent<ToolSet>): void;
+    /** @deprecated Use `onStepEnd` instead. */
     onStepFinish(event: GenerateTextStepEndEvent<ToolSet>): void;
     onEnd(event: GenerateTextEndEvent<ToolSet> | GenerateObjectEndEvent<unknown> | EmbedEndEvent | RerankEndEvent): void;
     private onGenerateEnd;
@@ -95,10 +105,11 @@ declare class OpenTelemetry implements Telemetry {
     private onRerankOperationEnd;
     onRerankStart(event: RerankingModelCallStartEvent): void;
     onRerankEnd(event: RerankingModelCallEndEvent): void;
+    onAbort(event: GenerateTextAbortEvent<ToolSet>): void;
     onError(error: unknown): void;
 }
 
-interface OtelStepStartEvent<TOOLS extends ToolSet = ToolSet, RUNTIME_CONTEXT extends Context = Context, OUTPUT extends OutputInterface = OutputInterface> extends GenerateTextStepStartEvent<TOOLS, RUNTIME_CONTEXT, OUTPUT> {
+interface OtelStepStartEvent<TOOLS extends ToolSet = ToolSet, RUNTIME_CONTEXT extends Context = Context, OUTPUT extends Output.Output = Output.Output> extends GenerateTextStepStartEvent<TOOLS, RUNTIME_CONTEXT, OUTPUT> {
     readonly promptMessages?: LanguageModelV4Prompt;
     readonly stepTools?: ReadonlyArray<Record<string, unknown>>;
     readonly stepToolChoice?: unknown;
@@ -119,17 +130,27 @@ declare class LegacyOpenTelemetry implements Telemetry {
         toolCallId: string;
         execute: () => PromiseLike<T>;
     }): PromiseLike<T>;
+    /**
+     * Runs the provider `doGenerate`/`doStream` call with the active legacy
+     * model-call context.
+     */
+    executeLanguageModelCall<T>({ callId, execute, }: {
+        callId: string;
+        execute: () => PromiseLike<T>;
+    }): PromiseLike<T>;
     onStart(event: InferTelemetryEvent<GenerateTextStartEvent> | InferTelemetryEvent<GenerateObjectStartEvent> | InferTelemetryEvent<EmbedStartEvent> | InferTelemetryEvent<RerankStartEvent>): void;
     private onGenerateStart;
     private onObjectOperationStart;
     /** @deprecated */
     onObjectStepStart(event: GenerateObjectStepStartEvent): void;
     /** @deprecated */
-    onObjectStepFinish(event: GenerateObjectStepEndEvent): void;
+    onObjectStepEnd(event: GenerateObjectStepEndEvent): void;
     private onEmbedOperationStart;
     onStepStart(event: OtelStepStartEvent): void;
     onToolExecutionStart(event: ToolExecutionStartEvent<ToolSet>): void;
     onToolExecutionEnd(event: ToolExecutionEndEvent<ToolSet>): void;
+    onStepEnd(event: GenerateTextStepEndEvent<ToolSet>): void;
+    /** @deprecated Use `onStepEnd` instead. */
     onStepFinish(event: GenerateTextStepEndEvent<ToolSet>): void;
     onEnd(event: GenerateTextEndEvent<ToolSet> | GenerateObjectEndEvent<unknown> | EmbedEndEvent | RerankEndEvent): void;
     private onGenerateEnd;
@@ -141,6 +162,7 @@ declare class LegacyOpenTelemetry implements Telemetry {
     private onRerankOperationEnd;
     onRerankStart(event: RerankingModelCallStartEvent): void;
     onRerankEnd(event: RerankingModelCallEndEvent): void;
+    onAbort(event: GenerateTextAbortEvent<ToolSet>): void;
     onError(error: unknown): void;
 }