Skip to content

feat(span-first): Add sentry.profile_id and sentry.replay_id as common span attributes #16051

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

Draft
Lms24 wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −0
Draft

feat(span-first): Add sentry.profile_id and sentry.replay_id as common span attributes #16051

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions develop-docs/sdk/telemetry/spans/span-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ Empty attributes must be omitted.
| `sentry.segment.name` | string | The segment name (e.g., "GET /users") |
| `sentry.segment.id` | string | The segment span id |
| `sentry.span.source` | string | The source of the span name. **MUST** be set on segment spans, **MAY** be set on child spans. <br/> See [Sentry Conventions](https://github.com/getsentry/sentry-conventions/attributes/sentry#sentry-span-source) for all supported sources. <br/>See [Transaction Annotations](/sdk/data-model/event-payloads/transaction/#transaction-annotations) and [Clustering](/backend/application-domains/transaction-clustering/#automatic-transaction-clustering) for more information.|
| `sentry.profile_id` | string | The id of the currently running profile (if available) |
Copy link

@sentry sentry bot Jan 16, 2026

Choose a reason for hiding this comment

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

Bug: The documentation introduces sentry.profile_id, but existing profiling systems use profiler_id. This inconsistency may break the linking between spans and profiles if the backend expects the old name.
Severity: CRITICAL

Suggested Fix

Confirm with the backend team whether the expected attribute for linking profiles to spans is the newly introduced sentry.profile_id or the existing profiler_id. Update the documentation to use the correct and consistent name to avoid implementation errors in SDKs. If this is a deliberate change, it should be explicitly noted.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: develop-docs/sdk/telemetry/spans/span-protocol.mdx#L172

Potential issue: The documentation introduces `sentry.profile_id` as a span attribute
for linking profiles. However, existing profiling documentation and sample formats
consistently use `profiler_id` for this purpose. This discrepancy could lead to a
functional bug if SDKs adopt `sentry.profile_id` while backend systems responsible for
associating profiles with spans still expect the `profiler_id` field. This would result
in profiles not being correctly linked to their corresponding spans, breaking the
connection in the UI. The analysis notes this could be an intentional standardization,
but without confirmation, it poses a risk.

Did we get this right? 👍 / 👎 to inform future reviews.

| `sentry.replay_id` | string | The id of the currently running replay (if available) |
| `os.name` | string | The operating system name (e.g., "Linux", "Windows", "macOS") |
| `browser.name` | string | The browser name (e.g., "Chrome", "Firefox", "Safari") |
| `user.id` | string | The user ID (gated by `sendDefaultPii`) |
Expand Down