Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Trace Vercel AI SDK agents — no instrumentModules config required
instrumentModules config required.
npm install @traceroot-ai/traceroot ai@^7 @ai-sdk/otel@^1 @ai-sdk/openai@^4 zod@^4
TraceRoot.initialize() and register the AI SDK’s OpenTelemetry integration before your first model call:import { TraceRoot } from '@traceroot-ai/traceroot';
import { registerTelemetry } from 'ai';
import { OpenTelemetry } from '@ai-sdk/otel';
TraceRoot.initialize();
// Required on AI SDK 7 — without it, no spans are emitted.
registerTelemetry(new OpenTelemetry({ usage: true }));
npm install @traceroot-ai/traceroot ai@^6 @ai-sdk/openai@^3 zod@^4
TraceRoot.initialize() before your first model call:import { TraceRoot } from '@traceroot-ai/traceroot';
TraceRoot.initialize();
experimental_telemetry: { isEnabled: true } on each call (see Usage).generateText / streamText call, model call, and tool execution is captured automatically:
import { TraceRoot } from '@traceroot-ai/traceroot';
import { registerTelemetry, generateText, tool, isStepCount } from 'ai';
import { OpenTelemetry } from '@ai-sdk/otel';
import { openai } from '@ai-sdk/openai';
import { z } from 'zod';
TraceRoot.initialize();
registerTelemetry(new OpenTelemetry({ usage: true }));
// The agent run, both model calls, and the getWeather tool call are all traced.
const result = await generateText({
model: openai('gpt-4o-mini'),
instructions: 'You are a concise weather assistant.',
prompt: 'What is the weather in Tokyo?',
stopWhen: isStepCount(5),
telemetry: { functionId: 'weather_agent' },
tools: {
getWeather: tool({
description: 'Get current weather for a city',
inputSchema: z.object({ city: z.string() }),
execute: async ({ city }) => ({ city, temp: 72, condition: 'sunny' }),
}),
},
});
console.log(result.text);
await TraceRoot.flush();
import { TraceRoot } from '@traceroot-ai/traceroot';
import { generateText, tool, stepCountIs } from 'ai';
import { openai } from '@ai-sdk/openai';
import { z } from 'zod';
TraceRoot.initialize();
// The agent run, both model calls, and the getWeather tool call are all traced.
const result = await generateText({
model: openai('gpt-4o-mini'),
system: 'You are a concise weather assistant.',
prompt: 'What is the weather in Tokyo?',
stopWhen: stepCountIs(5),
// Required on every call in AI SDK 6.
experimental_telemetry: { isEnabled: true, functionId: 'weather_agent' },
tools: {
getWeather: tool({
description: 'Get current weather for a city',
inputSchema: z.object({ city: z.string() }),
execute: async ({ city }) => ({ city, temp: 72, condition: 'sunny' }),
}),
},
});
console.log(result.text);
await TraceRoot.flush();
| Attribute | Description |
|---|---|
| Model | The model passed to generateText / streamText / ToolLoopAgent |
| Messages | Input prompt and message history |
| Response | Generated text output |
| Tool calls | Each tool invocation with input and output |
| Tokens | Input and output token counts |
| Cost | Calculated from token usage and model pricing |
| Latency | Request duration per span |
| Multi-step iterations | Each step of a tool loop captured as a child span |