Skip to content

feat: Update vercel ai span names and ops as per new conventions #16497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
+300 −93
Open

feat: Update vercel ai span names and ops as per new conventions #16497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd776a9
feat: Update span name and op as per new conventions
AbhiPrasad Jun 5, 2025
7fe387d
set otel tool call attributes
AbhiPrasad Jun 8, 2025
c35f3d8
fix tests
AbhiPrasad Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/vercelai/scenario.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as Sentry from '@sentry/node';
import { generateText } from 'ai';
import { MockLanguageModelV1 } from 'ai/test';
import { z } from 'zod';

async function run() {
await Sentry.startSpan({ op: 'function', name: 'main' }, async () => {
Expand Down Expand Up @@ -30,6 +31,35 @@ async function run() {
prompt: 'Where is the second span?',
});

// This span should include tool calls and tool results
await generateText({
model: new MockLanguageModelV1({
doGenerate: async () => ({
rawCall: { rawPrompt: null, rawSettings: {} },
finishReason: 'tool-calls',
usage: { promptTokens: 15, completionTokens: 25 },
text: 'Tool call completed!',
toolCalls: [
{
toolCallType: 'function',
toolCallId: 'call-1',
toolName: 'getWeather',
args: '{ "location": "San Francisco" }',
},
],
}),
}),
tools: {
getWeather: {
parameters: z.object({ location: z.string() }),
execute: async args => {
return `Weather in ${args.location}: Sunny, 72°F`;
},
},
},
prompt: 'What is the weather in San Francisco?',
});

// This span should not be captured because we've disabled telemetry
await generateText({
experimental_telemetry: { isEnabled: false },
Expand Down
194 changes: 174 additions & 20 deletions dev-packages/node-integration-tests/suites/tracing/vercelai/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ describe('Vercel AI integration', () => {
'gen_ai.usage.output_tokens': 20,
'gen_ai.usage.total_tokens': 30,
'operation.name': 'ai.generateText',
'sentry.op': 'ai.pipeline.generateText',
'sentry.op': 'ai.pipeline.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText',
op: 'ai.pipeline.generateText',
op: 'ai.pipeline.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Second span - explicitly enabled telemetry but recordInputs/recordOutputs not set, should not record when sendDefaultPii: false
expect.objectContaining({
data: {
'sentry.origin': 'auto.vercelai.otel',
'sentry.op': 'ai.run.doGenerate',
'sentry.op': 'gen_ai.generate_text',
'operation.name': 'ai.generateText.doGenerate',
'ai.operationId': 'ai.generateText.doGenerate',
'ai.model.provider': 'mock-provider',
Expand All @@ -59,8 +59,8 @@ describe('Vercel AI integration', () => {
'gen_ai.response.model': 'mock-model-id',
'gen_ai.usage.total_tokens': 30,
},
description: 'generateText.doGenerate',
op: 'ai.run.doGenerate',
description: 'generate_text mock-model-id',
op: 'gen_ai.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
Expand All @@ -83,19 +83,19 @@ describe('Vercel AI integration', () => {
'gen_ai.usage.output_tokens': 20,
'gen_ai.usage.total_tokens': 30,
'operation.name': 'ai.generateText',
'sentry.op': 'ai.pipeline.generateText',
'sentry.op': 'ai.pipeline.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText',
op: 'ai.pipeline.generateText',
op: 'ai.pipeline.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Fourth span - doGenerate for explicit telemetry enabled call
expect.objectContaining({
data: {
'sentry.origin': 'auto.vercelai.otel',
'sentry.op': 'ai.run.doGenerate',
'sentry.op': 'gen_ai.generate_text',
'operation.name': 'ai.generateText.doGenerate',
'ai.operationId': 'ai.generateText.doGenerate',
'ai.model.provider': 'mock-provider',
Expand All @@ -119,8 +119,79 @@ describe('Vercel AI integration', () => {
'gen_ai.response.model': 'mock-model-id',
'gen_ai.usage.total_tokens': 30,
},
description: 'generateText.doGenerate',
op: 'ai.run.doGenerate',
description: 'generate_text mock-model-id',
op: 'gen_ai.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Fifth span - tool call generateText span
expect.objectContaining({
data: {
'ai.model.id': 'mock-model-id',
'ai.model.provider': 'mock-provider',
'ai.operationId': 'ai.generateText',
'ai.pipeline.name': 'generateText',
'ai.response.finishReason': 'tool-calls',
'ai.settings.maxRetries': 2,
'ai.settings.maxSteps': 1,
'ai.streaming': false,
'gen_ai.response.model': 'mock-model-id',
'gen_ai.usage.input_tokens': 15,
'gen_ai.usage.output_tokens': 25,
'gen_ai.usage.total_tokens': 40,
'operation.name': 'ai.generateText',
'sentry.op': 'ai.pipeline.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText',
op: 'ai.pipeline.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Sixth span - tool call doGenerate span
expect.objectContaining({
data: {
'ai.model.id': 'mock-model-id',
'ai.model.provider': 'mock-provider',
'ai.operationId': 'ai.generateText.doGenerate',
'ai.pipeline.name': 'generateText.doGenerate',
'ai.response.finishReason': 'tool-calls',
'ai.response.id': expect.any(String),
'ai.response.model': 'mock-model-id',
'ai.response.timestamp': expect.any(String),
'ai.settings.maxRetries': 2,
'ai.streaming': false,
'gen_ai.request.model': 'mock-model-id',
'gen_ai.response.finish_reasons': ['tool-calls'],
'gen_ai.response.id': expect.any(String),
'gen_ai.response.model': 'mock-model-id',
'gen_ai.system': 'mock-provider',
'gen_ai.usage.input_tokens': 15,
'gen_ai.usage.output_tokens': 25,
'gen_ai.usage.total_tokens': 40,
'operation.name': 'ai.generateText.doGenerate',
'sentry.op': 'gen_ai.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generate_text mock-model-id',
op: 'gen_ai.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Seventh span - tool call execution span
expect.objectContaining({
data: {
'ai.operationId': 'ai.toolCall',
'ai.toolCall.id': 'call-1',
'ai.toolCall.name': 'getWeather',
'gen_ai.tool.call.id': 'call-1',
'gen_ai.tool.name': 'getWeather',
'operation.name': 'ai.toolCall',
'sentry.op': 'gen_ai.execute_tool',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'execute_tool getWeather',
op: 'gen_ai.execute_tool',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
Expand Down Expand Up @@ -149,11 +220,11 @@ describe('Vercel AI integration', () => {
'gen_ai.usage.output_tokens': 20,
'gen_ai.usage.total_tokens': 30,
'operation.name': 'ai.generateText',
'sentry.op': 'ai.pipeline.generateText',
'sentry.op': 'ai.pipeline.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText',
op: 'ai.pipeline.generateText',
op: 'ai.pipeline.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
Expand Down Expand Up @@ -182,11 +253,11 @@ describe('Vercel AI integration', () => {
'gen_ai.usage.output_tokens': 20,
'gen_ai.usage.total_tokens': 30,
'operation.name': 'ai.generateText.doGenerate',
'sentry.op': 'ai.run.doGenerate',
'sentry.op': 'gen_ai.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText.doGenerate',
op: 'ai.run.doGenerate',
description: 'generate_text mock-model-id',
op: 'gen_ai.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
Expand All @@ -209,19 +280,19 @@ describe('Vercel AI integration', () => {
'gen_ai.usage.output_tokens': 20,
'gen_ai.usage.total_tokens': 30,
'operation.name': 'ai.generateText',
'sentry.op': 'ai.pipeline.generateText',
'sentry.op': 'ai.pipeline.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText',
op: 'ai.pipeline.generateText',
op: 'ai.pipeline.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Fourth span - doGenerate for explicitly enabled telemetry call
expect.objectContaining({
data: {
'sentry.origin': 'auto.vercelai.otel',
'sentry.op': 'ai.run.doGenerate',
'sentry.op': 'gen_ai.generate_text',
'operation.name': 'ai.generateText.doGenerate',
'ai.operationId': 'ai.generateText.doGenerate',
'ai.model.provider': 'mock-provider',
Expand All @@ -245,8 +316,91 @@ describe('Vercel AI integration', () => {
'gen_ai.response.model': 'mock-model-id',
'gen_ai.usage.total_tokens': 30,
},
description: 'generateText.doGenerate',
op: 'ai.run.doGenerate',
description: 'generate_text mock-model-id',
op: 'gen_ai.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Fifth span - tool call generateText span (should include prompts when sendDefaultPii: true)
expect.objectContaining({
data: {
'ai.model.id': 'mock-model-id',
'ai.model.provider': 'mock-provider',
'ai.operationId': 'ai.generateText',
'ai.pipeline.name': 'generateText',
'ai.prompt': '{"prompt":"What is the weather in San Francisco?"}',
'ai.response.finishReason': 'tool-calls',
'ai.response.text': 'Tool call completed!',
'ai.response.toolCalls': expect.any(String),
'ai.settings.maxRetries': 2,
'ai.settings.maxSteps': 1,
'ai.streaming': false,
'gen_ai.prompt': '{"prompt":"What is the weather in San Francisco?"}',
'gen_ai.response.model': 'mock-model-id',
'gen_ai.usage.input_tokens': 15,
'gen_ai.usage.output_tokens': 25,
'gen_ai.usage.total_tokens': 40,
'operation.name': 'ai.generateText',
'sentry.op': 'ai.pipeline.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generateText',
op: 'ai.pipeline.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Sixth span - tool call doGenerate span (should include prompts when sendDefaultPii: true)
expect.objectContaining({
data: {
'ai.model.id': 'mock-model-id',
'ai.model.provider': 'mock-provider',
'ai.operationId': 'ai.generateText.doGenerate',
'ai.pipeline.name': 'generateText.doGenerate',
'ai.prompt.format': expect.any(String),
'ai.prompt.messages': expect.any(String),
'ai.prompt.toolChoice': expect.any(String),
'ai.prompt.tools': expect.any(Array),
'ai.response.finishReason': 'tool-calls',
'ai.response.id': expect.any(String),
'ai.response.model': 'mock-model-id',
'ai.response.text': 'Tool call completed!',
'ai.response.timestamp': expect.any(String),
'ai.response.toolCalls': expect.any(String),
'ai.settings.maxRetries': 2,
'ai.streaming': false,
'gen_ai.request.model': 'mock-model-id',
'gen_ai.response.finish_reasons': ['tool-calls'],
'gen_ai.response.id': expect.any(String),
'gen_ai.response.model': 'mock-model-id',
'gen_ai.system': 'mock-provider',
'gen_ai.usage.input_tokens': 15,
'gen_ai.usage.output_tokens': 25,
'gen_ai.usage.total_tokens': 40,
'operation.name': 'ai.generateText.doGenerate',
'sentry.op': 'gen_ai.generate_text',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'generate_text mock-model-id',
op: 'gen_ai.generate_text',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
// Seventh span - tool call execution span
expect.objectContaining({
data: {
'ai.operationId': 'ai.toolCall',
'ai.toolCall.args': expect.any(String),
'ai.toolCall.id': 'call-1',
'ai.toolCall.name': 'getWeather',
'ai.toolCall.result': expect.any(String),
'gen_ai.tool.call.id': 'call-1',
'gen_ai.tool.name': 'getWeather',
'operation.name': 'ai.toolCall',
'sentry.op': 'gen_ai.execute_tool',
'sentry.origin': 'auto.vercelai.otel',
},
description: 'execute_tool getWeather',
op: 'gen_ai.execute_tool',
origin: 'auto.vercelai.otel',
status: 'ok',
}),
Expand Down
0 ...tegrations/tracing/vercelai/attributes.ts → ...ons/tracing/vercelai/ai_sdk_attributes.ts
View file
Open in desktop
File renamed without changes.
Loading