feat(span-first): Add sentry.profile_id and sentry.replay_id as common span attributes
#16051
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ommon span attributes
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| | `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) | |
There was a problem hiding this comment.
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.
Member
Author
|
Set to draft for now to confirm with profiling folks if the attribute is correct |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Adds
sentry.replay_idandsentry.profile_idas common span attributes to be added to every span.(We talked about this a while ago but I realized I never added it to dev docs. Sorry for the delay!)
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES