Skip to content

docs: list Sentry among OTel-compatible instrumentation backends - #2913

Open
sergical wants to merge 2 commits into
vercel:mainfrom
sergical:docs/sentry-in-instrumentation-guide
Open

docs: list Sentry among OTel-compatible instrumentation backends#2913
sergical wants to merge 2 commits into
vercel:mainfrom
sergical:docs/sentry-in-instrumentation-guide

Conversation

@sergical

@sergical sergical commented Sep 2, 2026

Copy link
Copy Markdown

Summary

The instrumentation guide names the OTel-compatible backends eve works with and links the PostHog integration, but it does not mention Sentry, even though eve ships a Sentry instrumentation in its registry (eve add instrumentation/sentry, documented at /integrations/sentry-instrumentation).

This adds Sentry to the backend list in the OpenTelemetry section, links the Sentry integration page next to the PostHog one, and adds Sentry to the list of third-party backends in the workflow run tags section.

It also updates the "Authored trace hierarchy" tree. eve registers the AI SDK's OpenTelemetry integration, which emits GenAI semantic-convention spans (invoke_agent <model>, step N, chat <model>, execute_tool <tool>). The guide still showed the legacy ai.streamText and ai.toolCall names, which no longer appear in exported traces. Verified against a live trace exported to Sentry from eve 0.49.

Docs-only change, no changeset.

Created with Claude Code

@vercel

vercel Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

@sergical is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@sergical
sergical marked this pull request as ready for review September 2, 2026 21:51
Signed-off-by: Sergiy Dybskiy <sergiy.dybskiy@sentry.io>
@sergical
sergical force-pushed the docs/sentry-in-instrumentation-guide branch from 8b93551 to 61fc436 Compare September 2, 2026 22:37
| +-- ai.toolCall {toolName: read}
+-- ai.streamText step 3 (final text)
+-- invoke_agent <agent> gen_ai.operation.name=invoke_agent
+-- step 1 gen_ai.operation.name=agent_step

@vercel vercel Bot Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The trace-hierarchy diagram claims the per-step span carries gen_ai.operation.name=agent_step, an attribute/value that eve never emits.

Fix on Vercel

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section documents the setup path, where eve creates ai.eve.turn (runtime.ts#L298) and hands telemetry to the AI SDK. On that path the step span comes from @ai-sdk/otel, not from eve. At the version eve pins (1.0.58), the integration sets gen_ai.operation.name: 'agent_step' (open-telemetry.ts#L648) and names the span step ${n} (open-telemetry.ts#L663).

eve's own provider in tracing/agent-otel-provider.ts emits no step spans, but that provider is not active in this hierarchy. I added a sentence that says which path the tree describes.

@sergical
sergical force-pushed the docs/sentry-in-instrumentation-guide branch from 61fc436 to 7e6825c Compare September 2, 2026 22:42
| +-- ai.streamText.doStream
| +-- ai.toolCall {toolName: read}
+-- ai.streamText step 3 (final text)
+-- invoke_agent <model> gen_ai.operation.name=invoke_agent

@vercel vercel Bot Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs incorrectly claim the invoke_agent span is named after the model and that gen_ai.agent.name holds a different value; both the diagram (invoke_agent <model>) and the prose are wrong.

Fix on Vercel

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same split. eve's provider names the span invoke_agent <agentName> (agent-otel-provider.ts#L677). The AI SDK integration names it ${operationName} ${event.modelId} (open-telemetry.ts#L305) and puts the agent name on gen_ai.agent.name from telemetry.functionId (open-telemetry.ts#L275), which eve defaults to the agent name (runtime.ts#L291).

I verified the resulting span name invoke_agent anthropic/claude-sonnet-5 in a trace exported from eve 0.49. The added sentence covers the provider case.

The AI SDK OpenTelemetry integration emits invoke_agent, agent_step, chat, and execute_tool spans. The guide still listed the legacy ai.streamText and ai.toolCall names.

Signed-off-by: Sergiy Dybskiy <sergiy.dybskiy@sentry.io>
@sergical
sergical force-pushed the docs/sentry-in-instrumentation-guide branch from 7e6825c to 464f2a6 Compare September 2, 2026 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant