Skip to content

vercelAIIntegration: record AI SDK v7 runtimeContext (filtered by telemetry.includeRuntimeContext) as span attributes #24706

Description

@BrandonNoad

Problem Statement

AI SDK v7 removed telemetry.metadata. Per-call metadata now goes in runtimeContext, and the app opts keys into telemetry with telemetry.includeRuntimeContext (telemetry docs, runtime context docs). @ai-sdk/otel records the included keys as ai.settings.runtimeContext.*. On v6 the equivalent data arrived through experimental_telemetry.metadata as vercel.ai.telemetry.metadata.*.

The v7 channel subscriber in @sentry/server-utils (vercel-ai-dc-subscriber, added in #21613) never reads runtimeContext, so on v7 there is no way to attach request-level metadata (user, tenant, request id, ...) to gen_ai spans. The integration docs say not to combine registerTelemetry with vercelAIIntegration, so registering @ai-sdk/otel alongside it is not a workaround either.

await streamText({
  model,
  messages,
  runtimeContext: { requestId: 'req_123', tenantId: 'acme', apiToken: 'secret' },
  telemetry: {
    isEnabled: true,
    functionId: 'support-chat',
    includeRuntimeContext: { requestId: true, tenantId: true },
  },
});
  • Expected: the gen_ai.invoke_agent span (and ideally its gen_ai.generate_content / gen_ai.execute_tool children) carries requestId and tenantId, and not apiToken.
  • Actual: none of the keys appear. The span has only vercel.ai.operationId, vercel.ai.model.provider, vercel.ai.settings.maxRetries and the gen_ai.* attributes.

Checked against @sentry/node 10.71.0 and the @sentry/server-utils subscriber in 10.75.3 and 11.0.0, with ai 7.0.100 / 7.0.113 on Node.

Solution Brainstorm

  • In buildInvokeAgentSpan, set one attribute per event.runtimeContext key. vercel.ai.settings.runtimeContext.<key> would match @ai-sdk/otel's ai.settings.runtimeContext.* under the existing ai.* to vercel.ai.* renaming.
  • Copy the same attributes onto child generate_content / execute_tool spans through the existing callId maps (like operationIdByCallId), since those channel events do not carry runtimeContext.
  • Optionally, record event.toolContext on execute_tool spans, which the AI SDK filters by telemetry.includeToolsContext.

Dependency on the AI SDK. In ai <= 7.0.113 the channel publishes runtimeContext / toolsContext unfiltered, ignoring includeRuntimeContext (vercel/ai#21442). Reading event.runtimeContext on those versions would send keys the app never opted in to telemetry. The fix is open in vercel/ai#21447, which filters channel events the same way as registered integrations. So this should only read the field on AI SDK versions that include that fix, or otherwise guard against unfiltered context.

Additional Context

#24660 notes the same gap from the Cloudflare Think side ("neither subscriber reads either field").

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions