From 7bd3c5001bad9f53748e166d9fa177eb4304fa88 Mon Sep 17 00:00:00 2001 From: "sentry-junior[bot]" <264270552+sentry-junior[bot]@users.noreply.github.com> Date: Tue, 17 Nov 2026 10:58:28 +0000 Subject: [PATCH 1/2] feat(server-utils): Record Vercel AI Gateway cost on AI SDK spans Co-Authored-By: Francesco Gringl-Novy <2411343+mydea@users.noreply.github.com> --- .../server-utils/src/ai/vercel-ai/index.ts | 7 +++ .../src/ai/vercel-ai/vercel-ai-attributes.ts | 1 + .../vercel-ai/vercel-ai-dc-subscriber.ts | 15 ++++++ .../vercel-ai/gateway-cost.test.ts | 52 +++++++++++++++++++ 4 files changed, 75 insertions(+) create mode 100644 packages/server-utils/test/integrations/vercel-ai/gateway-cost.test.ts diff --git a/packages/server-utils/src/ai/vercel-ai/index.ts b/packages/server-utils/src/ai/vercel-ai/index.ts index 3296eb18a73f..a0324d52491e 100644 --- a/packages/server-utils/src/ai/vercel-ai/index.ts +++ b/packages/server-utils/src/ai/vercel-ai/index.ts @@ -1,5 +1,6 @@ import type { SpanAttributeValue } from '@sentry/core'; import { + GEN_AI_COST_TOTAL_TOKENS, GEN_AI_USAGE_CACHE_CREATION_INPUT_TOKENS, GEN_AI_USAGE_CACHE_READ_INPUT_TOKENS, GEN_AI_USAGE_OUTPUT_TOKENS, @@ -82,6 +83,12 @@ export function getProviderMetadataAttributes(providerMetadata: unknown): Record setAttributeIfDefined(attributes, GEN_AI_USAGE_REASONING_OUTPUT_TOKENS, googleUsage.thoughtsTokenCount); } + // Vercel AI Gateway reports the billed USD cost of the call, as a decimal string. + const gatewayCost = Number(metadata.gateway?.cost); + if (metadata.gateway?.cost != null && Number.isFinite(gatewayCost)) { + attributes[GEN_AI_COST_TOTAL_TOKENS] = gatewayCost; + } + return attributes; } diff --git a/packages/server-utils/src/ai/vercel-ai/vercel-ai-attributes.ts b/packages/server-utils/src/ai/vercel-ai/vercel-ai-attributes.ts index 4c6538742c2a..f95ac607023a 100644 --- a/packages/server-utils/src/ai/vercel-ai/vercel-ai-attributes.ts +++ b/packages/server-utils/src/ai/vercel-ai/vercel-ai-attributes.ts @@ -250,4 +250,5 @@ export interface ProviderMetadata { vertex?: GoogleGenerativeAIProviderMetadata; // v6: Google Vertex uses 'vertex' key instead of 'google' deepseek?: DeepSeekProviderMetadata; perplexity?: PerplexityProviderMetadata; + gateway?: { cost?: string | number }; } diff --git a/packages/server-utils/src/integrations/vercel-ai/vercel-ai-dc-subscriber.ts b/packages/server-utils/src/integrations/vercel-ai/vercel-ai-dc-subscriber.ts index d19111cb39be..efd55f98874a 100644 --- a/packages/server-utils/src/integrations/vercel-ai/vercel-ai-dc-subscriber.ts +++ b/packages/server-utils/src/integrations/vercel-ai/vercel-ai-dc-subscriber.ts @@ -1,6 +1,7 @@ /* eslint-disable max-lines */ import { GEN_AI_CONVERSATION_ID, + GEN_AI_COST_TOTAL_TOKENS, GEN_AI_EMBEDDINGS_INPUT, GEN_AI_FUNCTION_ID, GEN_AI_INPUT_MESSAGES, @@ -130,6 +131,16 @@ const ROOT_OPERATION_TYPES = new Set([ 'rerank', ]); +// Operations whose `providerMetadata` cost covers only one of their provider calls: the last step of a +// text or object operation, whose cost the `generate_content` spans carry, or one `embedMany` chunk. +const PARTIAL_COST_OPERATION_TYPES = new Set([ + 'generateText', + 'streamText', + 'streamObject', + 'generateObject', + 'embedMany', +]); + /** Drop the per-operation `callId` maps once the owning top-level operation settles (success or error). */ export function clearOperationId(data: VercelAiChannelMessage): void { if (!ROOT_OPERATION_TYPES.has(data.type)) { @@ -201,6 +212,10 @@ function dropLastStepOnlyUsage(providerAttributes: Record { + beforeEach(() => { + getMainCarrier().__SENTRY__ = undefined; + }); + + afterEach(() => { + getMainCarrier().__SENTRY__ = undefined; + }); + + function runSpan(type: string, cost: unknown): Record { + const client = new TestClient( + getDefaultTestClientOptions({ dsn: 'https://public@dsn.ingest.sentry.io/1337', tracesSampleRate: 1 }), + ); + setCurrentClient(client); + client.init(); + const endedSpans: Span[] = []; + client.on('spanEnd', span => endedSpans.push(span)); + + const message = { + type, + event: {}, + result: { providerMetadata: { gateway: { cost } } }, + } as Parameters[0]; + const span = createSpanFromMessage(message, {} as Parameters[1]); + enrichSpanOnEnd(span!, message, {} as Parameters[2]); + span?.end(); + return spanToStaticSpanJSON(endedSpans[0]!).data ?? {}; + } + + it.each(['languageModelCall', 'embed', 'rerank', 'experimental_decide'])( + 'records the gateway cost on `%s` spans', + type => { + expect(runSpan(type, '0.0000074')[GEN_AI_COST_TOTAL_TOKENS]).toBe(0.0000074); + }, + ); + + it.each(['generateText', 'streamText', 'embedMany'])('leaves the partial gateway cost off `%s` spans', type => { + expect(runSpan(type, '0.0000074')).not.toHaveProperty(GEN_AI_COST_TOTAL_TOKENS); + }); + + it('accepts a numeric cost and ignores one that is not a number', () => { + expect(runSpan('languageModelCall', 0.5)[GEN_AI_COST_TOTAL_TOKENS]).toBe(0.5); + expect(runSpan('languageModelCall', 'n/a')).not.toHaveProperty(GEN_AI_COST_TOTAL_TOKENS); + }); +}); From c584c45e02a0b3a59ebc7ca6da5678603a29a4b9 Mon Sep 17 00:00:00 2001 From: "sentry-junior[bot]" <264270552+sentry-junior[bot]@users.noreply.github.com> Date: Tue, 17 Nov 2026 11:09:49 +0000 Subject: [PATCH 2/2] test(server-utils): Assert Vercel AI Gateway cost in the provider metadata scenario --- .../tracing/vercelai/v6_v7/scenario-provider-metadata.mjs | 1 + .../suites/tracing/vercelai/v6_v7/test.ts | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/scenario-provider-metadata.mjs b/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/scenario-provider-metadata.mjs index ad15640d1cf6..790b5a0ee8d7 100644 --- a/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/scenario-provider-metadata.mjs +++ b/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/scenario-provider-metadata.mjs @@ -23,6 +23,7 @@ async function run() { reasoningTokens: 7, responseId: 'resp_abc123', }, + gateway: { cost: '0.0000074' }, }, }), }), diff --git a/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/test.ts b/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/test.ts index d4774f9d34d4..20afbf2aff44 100644 --- a/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/test.ts +++ b/dev-packages/node-integration-tests/suites/tracing/vercelai/v6_v7/test.ts @@ -3,6 +3,7 @@ import type { Event } from '@sentry/node'; import { afterAll, describe, expect } from 'vitest'; import { GEN_AI_CONVERSATION_ID, + GEN_AI_COST_TOTAL_TOKENS, GEN_AI_EMBEDDINGS_INPUT, GEN_AI_INPUT_MESSAGES, GEN_AI_OPERATION_NAME, @@ -1098,9 +1099,12 @@ describe.each(matrix)('Vercel AI integration (version %s)', (version, vercelAiVe expect(generateContent.attributes[GEN_AI_USAGE_REASONING_OUTPUT_TOKENS]?.value).toBe(7); // The per-response `responseId` is not a conversation id and must not be recorded as one. expect(generateContent.attributes[GEN_AI_CONVERSATION_ID]).toBeUndefined(); + expect(generateContent.attributes[GEN_AI_COST_TOTAL_TOKENS]?.value).toBe(0.0000074); const invokeAgent = spans.find(span => span.attributes[SENTRY_OP]?.value === 'gen_ai.invoke_agent')!; expect(invokeAgent).toBeDefined(); + // `providerMetadata` holds only the last step's cost, which the model-call span already carries. + expect(invokeAgent.attributes[GEN_AI_COST_TOTAL_TOKENS]).toBeUndefined(); // The system prompt is supplied via the v7-only `instructions` option. Only the channel // instrumentation surfaces it (as `gen_ai.system_instructions`); v6 has no such option.