Instrument Vercel AI SDK Applications with OpenTelemetry
Learn how to instrument Vercel AI SDK-based applications with OpenTelemetry and export large language model (LLM) telemetry via OTLP into Cribl Search. Once your data is in Cribl Search, you can explore and investigate it to troubleshoot issues, analyze model behavior, and monitor performance.
You’ll complete the following high-level steps:
- Configure an OpenTelemetry (OTel) Source in Cribl Search to receive OTLP data.
- Instrument your Vercel AI SDK application with OpenTelemetry.
- Explore LLM telemetry use cases in Cribl Search.
Telemetry Captured
Each Vercel AI SDK call produces a trace with these attributes:
| Category | Data | Example |
|---|---|---|
| Timing | Full operation duration and per-provider-call duration. | 1.2s total, 0.9s provider call. |
| Model | Provider name, requested model, and actual response model. | openai, gpt-4o, gpt-4o-2024-08-06. |
| Token usage | Input, output, and cached tokens per step. | 150 input, 85 output. |
| Request params | Temperature, max tokens, top_p, and other generation settings. | temperature=0.7. |
| Response | Finish reasons and response ID. | stop, chatcmpl-abc123. |
| Tool calls | Tool name, arguments, and result for each tool execution. | execute_tool weather. |
| Structure | Span hierarchy for agent operations, provider calls, and tool executions. Follows OpenTelemetry GenAI Semantic Conventions. | invoke_agent, chat, execute_tool. |
| Errors | HTTP status and error message. | 429 Rate limit exceeded. |
| Content | Prompt and completion text. | (captured by default. See Capture Prompt/Completion Content.) |
Prerequisites
You’ll need:
- Cribl.Cloud Enterprise.
- Search Admin permission or higher.
- Node.js 22+ and an AI SDK provider API key (for example
OPENAI_API_KEY). - Vercel AI SDK v7 (
aipackage) installed in your project.
Get Data Into Cribl Search
Complete these steps before you instrument your LLM application:
- Add a Lakehouse engine. This provides storage and compute for data you’re going to ingest into Cribl Search.
- Add a Cribl Search OpenTelemetry Source to start ingesting the data.
- Set up your Datatype rules to parse and structure the incoming data.
- Set up your Dataset rules to route ingested events into individual Search Datasets. This will let you scope your queries and control retention.
Add a Lakehouse Engine
A Lakehouse engine is the storage-and-compute unit in Cribl Search that holds ingested OTLP (and other Source data) until Dataset retention expires. See Lakehouse Engines in Cribl Search to learn how to set up a new Lakehouse engine.
Configure the OpenTelemetry (OTel) Source in Cribl Search
To receive OTLP from your LLM application directly in Cribl Search, add an OpenTelemetry Source.
On the Cribl.Cloud top bar, select Products > Search. Under Data, select Add Source > OpenTelemetry.
In the New Source modal, configure the following under General Settings:
- ID: Unique Source ID across your Cribl.Cloud Workspace. Use letters, numbers, underscores, and hyphens.
- Description (optional): Describe the Source (for example, OTLP from LLM-instrumented apps).
- Address: Hostname that your OpenTelemetry collector or agent connects to. You will use this in exporter configuration.
- Port: Network port to listen on. Defaults to
4317for gRPC and4318for HTTP (OTLP standard). Change if you use a custom port. - OTLP version: Version that matches your upstream sender (default
1.3.1). - Protocol: gRPC (default) or HTTP. This must match your OpenTelemetry exporter.
Under Authentication, choose None, Basic, Basic (Credentials Secret), Auth Tokens, or Auth Token (Text Secret) as required. See Set up Authentication.
Under Encrypt, enable TLS and set the minimum TLS version when senders must connect over TLS. See Set Up Encryption.
Select Save to create the Source.
Set Datatype Rules
Next, configure Datatype rules to parse, filter, and normalize your data into structured fields.
On the Cribl.Cloud top bar, select Products > Search > Data > Datatyping (auto). Here, you can:
- Use Auto-Datatyping to parse your data automatically.
- Check for uncategorized data that didn’t match any Datatype rules.
- Handle the uncategorized data by adding custom Datatype rules.
See also:
- Datatypes in Cribl Search
- v2 Datatypes in Cribl Search
- List of Stock v2 Datatypes
- Add a Custom v2 Datatype
Add a Dataset and Set Dataset Rules
Next, create a Dataset and add Dataset rules to route parsed events into it.
Add a Dataset
- On the Cribl.Cloud top bar, select Products > Search > Data > Datasets.
- Select Add Dataset.
- Enter a unique ID.
- Optionally add a Description and Tags.
- Set Dataset Provider to lakehouse.
- Select the Lakehouse engine that will store the data.
- Set the Retention period.
- Select Save.
Set Dataset Rules
Dataset rules enable you to route ingested events into individual Search Datasets so you can scope your queries and control retention.
See Organize Your Data for details around how to configure your Dataset rules and plan your Search Datasets based on estimated future storage costs.
Instrument Your Application
Initialize the OTel NodeSDK and register the AI SDK telemetry integration at the top of your entry file, before any AI SDK imports. After registration, all AI SDK calls emit telemetry automatically.
AI SDK v7 requires ESM (ECMAScript Modules). Add
"type": "module"to yourpackage.json, or use.mjsfile extensions. CommonJSrequire()is not supported.
- Install the required packages:
npm install @ai-sdk/otel @opentelemetry/sdk-node @opentelemetry/exporter-trace-otlp-grpc- Create a
tracing.tsfile:
// tracing.ts: import this BEFORE any ai SDK calls
import { NodeSDK } from '@opentelemetry/sdk-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
import { registerTelemetry } from 'ai';
import { OpenTelemetry } from '@ai-sdk/otel';
const sdk = new NodeSDK({
traceExporter: new OTLPTraceExporter(),
});
sdk.start();
registerTelemetry(new OpenTelemetry());- Import
tracing.tsat the top of your application entry point, before any other imports:
// app.ts
import './tracing'; // must be first
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
const result = await generateText({
model: openai('gpt-4o'),
prompt: 'Hello!',
telemetry: {
functionId: 'chat-completion',
},
});
console.log(result.text);- Configure the environment variables and run your application.
Set Environment Variables
Set these environment variables before running your instrumented application. Replace <cribl-host> with your Cribl host address, and <token> with your Bearer token if authentication is enabled on the OTel Source.
Use gRPC (port 4317)
Set environment variables using gRPC. This is the recommended method:
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<cribl-host>:4317"
export OTEL_EXPORTER_OTLP_PROTOCOL="grpc"
export OTEL_SERVICE_NAME="my-ai-app"
# Only if you enabled auth on the Cribl OTEL Source:
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <token>"Use HTTP/protobuf (port 4318)
If your OTLP exporter or network path requires HTTP/protobuf instead of gRPC, use port 4318 and set the protocol as shown. If TLS is enabled on your Cribl OTel Source, use https:// instead of http://.
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<cribl-host>:4318"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
export OTEL_SERVICE_NAME="my-ai-app"
# Only if you enabled auth on the Cribl OTEL Source:
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <token>"Environment Variable Reference
| Variable | Required | Description |
|---|---|---|
OTEL_EXPORTER_OTLP_ENDPOINT | Yes | Cribl Search OpenTelemetry Source URL (http://<cribl-host>:4317 for gRPC, :4318 for HTTP). |
OTEL_EXPORTER_OTLP_PROTOCOL | Yes | grpc or http/protobuf. |
OTEL_SERVICE_NAME | Yes | Logical name for your application (appears in traces). |
OTEL_EXPORTER_OTLP_HEADERS | No | Auth header if the Source requires it (for example Authorization=Bearer <token>). |
| Provider API keys | As needed | For example OPENAI_API_KEY, ANTHROPIC_API_KEY, or the key for whichever AI SDK provider you use. |
Capture Prompt/Completion Content
The Vercel AI SDK records prompt inputs and completion outputs by default. Disable capture for calls that handle sensitive data.
To disable content capture for a specific call:
const result = await generateText({
model: openai('gpt-4o'),
prompt: 'Hello!',
telemetry: {
functionId: 'chat-completion',
recordInputs: false,
recordOutputs: false,
},
});To disable content capture globally, omit registerTelemetry() entirely, or set recordInputs/recordOutputs on every call. There is no global environment variable for this setting.
Verify Data Flow in Cribl Search
After completing the instrumentation process, confirm OTLP events flow from your instrumented app into Cribl Search.
- On the Cribl.Cloud top bar, select Products > Search > Data > Live Data.
- Select your OpenTelemetry Source and confirm that events appear while you trigger traffic from your application.
- For full Live Data behavior and troubleshooting, check See Live Data Flow.
Common Search Issues and Fixes
| Symptom | Cause | Fix |
|---|---|---|
| No events returned. | OpenTelemetry Source is not receiving data, or Dataset rules are not routing data correctly. | Verify the Source address, port, protocol, and auth settings. Check Data > Live Data for the OpenTelemetry Source, then confirm your Dataset rule sends matching events to the correct Search Dataset. |
| Empty time range. | No recent traffic, or event timestamps are outside your selected window. | Widen Time range and make an AI SDK call from your instrumented app. Review timestamp parsing in your Datatype configuration. |
| No spans emitted. | registerTelemetry() not called, or called after AI SDK imports. | Ensure registerTelemetry(new OpenTelemetry()) is called at startup before any generateText or other AI SDK calls. For Node.js, import './tracing' must be the first import in your entry file. |
No invoke_agent spans. | Next.js instrumentation file not loaded. | Confirm instrumentation.ts exists at the project root and that experimental.instrumentationHook is enabled in next.config.js if required by your Next.js version. |
| Spans appear but no content attributes. | recordInputs/recordOutputs disabled on calls. | Remove recordInputs: false and recordOutputs: false from the telemetry option, or omit the telemetry option entirely. |
| Connection or export errors. | Protocol mismatch or wrong port. | Match gRPC (4317) vs HTTP/protobuf (4318) to your Cribl Source. Set OTEL_LOG_LEVEL=debug to surface exporter errors. |
| 401 from a model provider. | Missing or invalid provider API key. | Set the correct provider environment variable (for example OPENAI_API_KEY). |
| Fields not where you expect. | Auto-Datatyping did not classify the events as expected, or your Datatype rules need refinement. | Review the data in Live Data, check for Uncategorized events, and update or add Datatype rules so the data parses into the fields you expect. |
| Slow or expensive searches. | Large partitions scanned. | Narrow time range, increase sampling, or pre-aggregate in Stream. |
| Permission errors. | Insufficient Search role. | Ask an Admin to grant Editor (or higher) for Dataset management, or User for running searches per org policy. |
LLM Telemetry Use Cases
With data flowing into Cribl Search, you can explore and gain visibility towards your Vercel AI SDK telemetry:
- Explore LLM telemetry: Explore your Search Dataset in Cribl Search and query it with KQL. Filter and slice by service, model, provider, environment, token usage, and error or status fields. Use
functionIdvalues to isolate specific agent flows or endpoints. - Investigate incidents and performance regressions: During elevated errors or latency, investigate your LLM Search Dataset. Use aggregations such as
summarizeortimestatsto break down failures by model, provider, deployment, or feature. Usejoinor related patterns with infrastructure or gateway Datasets for end-to-end context. - Build dashboards for LLM usage and cost: Use Cribl Search Dashboards to track requests over time by model or app, token usage, error rates by environment or provider, and latency percentiles (for example P95/P99) and traffic share.
- Automate checks with scheduled searches and notifications: Turn important queries (for example, when estimated LLM cost or error rate crosses a threshold over a time window) into Scheduled Searches and attach Notifications to email, Slack, SNS, webhooks, and other targets.
Learn how to instrument Vercel AI SDK-based applications with OpenTelemetry, export large language model (LLM) telemetry via OTLP, and send it into Cribl Stream. Once data is in Cribl Stream, you can route, mask, and enrich it before it reaches your observability backends.
You’ll complete the following high-level steps:
- Configure an OpenTelemetry (OTel) Source in Cribl Stream to receive OTLP data.
- Instrument your Vercel AI SDK application with OpenTelemetry.
- Explore LLM telemetry use cases for Cribl Stream.
Telemetry Captured
Each Vercel AI SDK call produces a trace with these attributes:
| Category | Data | Example |
|---|---|---|
| Timing | Full operation duration and per-provider-call duration. | 1.2s total, 0.9s provider call. |
| Model | Provider name, requested model, and actual response model. | openai, gpt-4o, gpt-4o-2024-08-06. |
| Token usage | Input, output, and cached tokens per step. | 150 input, 85 output. |
| Request params | Temperature, max tokens, top_p, and other generation settings. | temperature=0.7. |
| Response | Finish reasons and response ID. | stop, chatcmpl-abc123. |
| Tool calls | Tool name, arguments, and result for each tool execution. | execute_tool weather. |
| Structure | Span hierarchy for agent operations, provider calls, and tool executions. Follows OpenTelemetry GenAI Semantic Conventions. | invoke_agent, chat, execute_tool. |
| Errors | HTTP status and error message. | 429 Rate limit exceeded. |
| Content | Prompt and completion text. | (captured by default. See Capture Prompt/Completion Content.) |
Prerequisites
- A Cribl Stream instance (v4.x+) with an OpenTelemetry (OTEL) Source enabled.
- Node.js 22+ and an AI SDK provider API key (for example
OPENAI_API_KEY). - Vercel AI SDK v7 (
aipackage) installed in your project.
Configure the OpenTelemetry (OTel) Source in Cribl Stream
Before instrumenting your application, configure Cribl Stream to receive OTLP data.
Configure an OTel Source
You do not need a separate OpenTelemetry Source for each LLM or agent provider. Configure one OTel Source in Cribl Stream and point all instrumented applications at the same endpoint. Per application, only the service name and provider API key typically differ. Use Routes and Pipelines in Cribl Stream to filter and process events by
service.name.
To receive OTLP from your LLM application, add or edit an OpenTelemetry Source on your Worker Group as follows.
On the top bar, select Products, and then select Cribl Stream. Under Worker Groups, select a Worker Group. Next, you have two options:
- To configure via QuickConnect, navigate to Routing > QuickConnect (Stream) or Collect (Edge). Select Add Source and select the Source you want from the list, choosing either Select Existing or Add New.
- To configure via the Routes, select Data > Sources (Stream) or More > Sources (Edge). Select the Source you want. Next, select Add Source.
In the New Source modal, configure the following under General Settings:
- Input ID: Unique ID for this Source. For example,
OTel042. - Description: Optionally, enter a description.
- OTLP version: The drop-down offers
0.10.0and1.3.1(default). - Protocol: Use the drop-down to choose the protocol matching the data you will ingest:
gRPC(default), orHTTP. - Address: Enter the hostname/IP to listen on. Defaults to
0.0.0.0(all addresses, IPv4 format). - Port: By default, OTel applications send output to port
4317when using the gRPC protocol, and port4318when using HTTP. This setting defaults to4317- you must change it if you set Protocol (below) toHTTP, or you want Cribl Stream to collect data from an OTel application that is using a different port.
Port
4318is not available on Cribl-managed Worker Groups in Cribl.Cloud.- The Extract spans, Extract metrics, and Extract logs settings are specific to the OpenTelemetry Source. By default, these options are toggled off, allowing Cribl Stream to act as a pass-through that generates a single event for each incoming OTel payload. This is useful when you want to forward complete OTel events to downstream systems, such as persistent storage, without breaking them apart. You can enable these settings to extract and process individual records from within OTel events:
- Extract spans: Generates an individual event for each span in a trace. Traces typically contain multiple spans.
- Extract metrics: Generates an individual event for each data point in a metric event. OTel metrics often contain multiple data points per event.
- Extract logs: Available only when OTLP version is set to
1.3.1. Generates an individual event for each log record. Cribl recommends enabling this option to simplify log transformation and manipulation.
- Tags: Optionally, add tags to help filter and group Sources within Cribl Stream’s UI. Tags are not included in the event data. Separate tag names using a tab or hard return.
- Input ID: Unique ID for this Source. For example,
Optionally, you can adjust the Authentication, TLS, Persistent Queue Settings, Processing, and Advanced settings, or Connected Destinations.
Select Save, then Commit & Deploy.
Instrument Your Application
Initialize the OTel NodeSDK and register the AI SDK telemetry integration at the top of your entry file, before any AI SDK imports. After registration, all AI SDK calls emit telemetry automatically.
AI SDK v7 requires ESM (ECMAScript Modules). Add
"type": "module"to yourpackage.json, or use.mjsfile extensions. CommonJSrequire()is not supported.
- Install the required packages:
npm install @ai-sdk/otel @opentelemetry/sdk-node @opentelemetry/exporter-trace-otlp-grpc- Create a
tracing.tsfile:
// tracing.ts: import this BEFORE any ai SDK calls
import { NodeSDK } from '@opentelemetry/sdk-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
import { registerTelemetry } from 'ai';
import { OpenTelemetry } from '@ai-sdk/otel';
const sdk = new NodeSDK({
traceExporter: new OTLPTraceExporter(),
});
sdk.start();
registerTelemetry(new OpenTelemetry());- Import
tracing.tsat the top of your application entry point, before any other imports:
// app.ts
import './tracing'; // must be first
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
const result = await generateText({
model: openai('gpt-4o'),
prompt: 'Hello!',
telemetry: {
functionId: 'chat-completion',
},
});
console.log(result.text);- Configure the environment variables and run your application.
Set Environment Variables
Set these environment variables before running your instrumented application. Replace <cribl-host> with your Cribl host address, and <token> with your Bearer token if authentication is enabled on the OTel Source.
Use gRPC (port 4317)
Set environment variables using gRPC. This is the recommended method:
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<cribl-host>:4317"
export OTEL_EXPORTER_OTLP_PROTOCOL="grpc"
export OTEL_SERVICE_NAME="my-ai-app"
# Only if you enabled auth on the Cribl OTEL Source:
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <token>"Use HTTP/protobuf (port 4318)
If your OTLP exporter or network path requires HTTP/protobuf instead of gRPC, use port 4318 and set the protocol as shown. If TLS is enabled on your Cribl OTel Source, use https:// instead of http://.
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<cribl-host>:4318"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
export OTEL_SERVICE_NAME="my-ai-app"
# Only if you enabled auth on the Cribl OTEL Source:
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <token>"Environment Variable Reference
| Variable | Required | Description |
|---|---|---|
OTEL_EXPORTER_OTLP_ENDPOINT | Yes | Cribl Stream OTEL Source URL (http://<cribl-host>:4317 for gRPC, :4318 for HTTP). |
OTEL_EXPORTER_OTLP_PROTOCOL | Yes | grpc or http/protobuf. |
OTEL_SERVICE_NAME | Yes | Logical name for your application (appears in traces). |
OTEL_EXPORTER_OTLP_HEADERS | No | Auth header if Cribl Source requires it (for example Authorization=Bearer <token>). |
| Provider API keys | As needed | For example OPENAI_API_KEY, ANTHROPIC_API_KEY, or the key for whichever AI SDK provider you use. |
Capture Prompt/Completion Content
The Vercel AI SDK records prompt inputs and completion outputs by default. Use Cribl Stream’s masking and redaction functions to sanitize data before routing to downstream destinations.
To disable content capture for a specific call:
const result = await generateText({
model: openai('gpt-4o'),
prompt: 'Hello!',
telemetry: {
functionId: 'chat-completion',
recordInputs: false,
recordOutputs: false,
},
});To disable content capture globally, omit registerTelemetry() entirely, or set recordInputs/recordOutputs on every call. There is no global environment variable for this setting.
Verify Data Flow in Cribl Stream
After completing the instrumentation process, confirm OTLP events flow from your instrumented app into Cribl Stream.
- In Cribl Stream, go to Monitoring > Sources and select your OTel Source.
- Open the Live Data tab.
- Select Start Capture.
- Trigger a request in your application.
- Confirm that events appear in Live Data for your OTel Source.
Route Data to Cribl Search
After Vercel AI SDK OTLP data reaches Cribl Stream, add a Cribl Search Destination so you can explore and investigate LLM telemetry to troubleshoot issues, analyze model behavior, and monitor performance. See the Cribl Search Destination guide for setup instructions.
Common Stream Issues and Fixes
If spans are missing or the exporter cannot reach Cribl Stream, use this table to narrow down endpoint, authentication, TLS, library versions, and how instrumentation is loaded.
| Symptom | Cause | Fix |
|---|---|---|
| No data in Cribl Stream. | Wrong endpoint or port. | Verify OTEL_EXPORTER_OTLP_ENDPOINT matches the Cribl OTEL Source address and port. |
| Connection refused. | Source not running or firewall blocking. | Ensure the OTEL Source is enabled and the port is open. |
| 401 Unauthorized. | Auth mismatch. | Check OTEL_EXPORTER_OTLP_HEADERS matches the auth config on the Cribl Source. |
| No spans emitted. | registerTelemetry() not called, or called after AI SDK imports. | Ensure registerTelemetry(new OpenTelemetry()) is called at startup before any generateText or other AI SDK calls. For Node.js, import './tracing' must be the first import in your entry file. |
No invoke_agent spans. | Next.js instrumentation file not loaded. | Confirm instrumentation.ts exists at the project root and that experimental.instrumentationHook is enabled in next.config.js if required by your Next.js version. |
| Spans appear but no content attributes. | recordInputs/recordOutputs disabled on calls. | Remove recordInputs: false and recordOutputs: false from the telemetry option. |
| Connection or export errors. | Protocol mismatch or wrong port. | Match gRPC (4317) vs HTTP/protobuf (4318) to your Cribl Source. Set OTEL_LOG_LEVEL=debug to surface exporter errors. |
| 401 from a model provider. | Missing or invalid provider API key. | Set the correct provider environment variable (for example OPENAI_API_KEY). |
| TLS errors. | TLS mismatch. | Use https:// in the endpoint if TLS is enabled on the Source, or disable TLS on the Source for local testing. |
LLM Telemetry Use Cases
With data flowing into Cribl Stream, you can route Vercel AI SDK telemetry to any supported Destination. For example:
- Cribl Search: Search and analyze full-fidelity LLM traces and logs interactively.
- Cribl Lake: Store and search traces natively with partitioning optimized for Cribl Search, so you can query traces at scale without re-ingesting them into a separate system.
- Amazon S3 or other object storage: Archive traces for compliance or long-term analysis using partitioning schemes aligned with Cribl Search, so you can query data in place without moving it.
- OpenTelemetry: Forward LLM traces in standard OTLP format to downstream systems.
To set up routing:
- Add Routes in Routing > Data Routes to match OTel data and direct it to your chosen Destinations.
- Go to Processing > Pipelines and create a Pipeline to process data flowing down your Route.
- Use Functions to enrich, filter, sample, or redact data before delivery. For example:
- Mask prompt/completion content containing sensitive information.
- Sample high-volume traces to reduce cost.
- Aggregate token usage metrics by model or service.
For more detailed LLM telemetry use cases, see LLM Telemetry Use Cases in Cribl.