fix(develop): clarify trace context's client_sample_rate #13174
Conversation
This file contains 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
When reading the Trace Context docs, I assumed that `client_sample_rate` (like all the other fields) was expected to be set by the client. Instead, this field is generated in Relay. If a client sets this field, it will be ignored and overwritten. Added a note to the docs for this field to clarify how it is meant to be used.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Dav1dde
reviewed
Mar 31, 2025
| @@ -682,7 +682,7 @@ Additional information that allows Sentry to connect multiple transactions, span | |||
|
|
|||
| `client_sample_rate` | |||
|
|
|||
| : _Optional_. The client-side sample rate. | |||
| : _Optional_. The client-side sample rate. This field will be populated by relay. Incoming values are ignored. | |||
There was a problem hiding this comment.
I don't think this is fully correct, we have a code path which re-creates the DSC when the parent project is not in the same org or missing.
Maybe @jan-auer can also chime in?
There was a problem hiding this comment.
Yes, this was the subject of @jan-auer's recent changes. The DSC generation happens here. But the sample rate is taken from the incoming DSC, never from the trace context's client_sample_rate - that field is never read, only set (taken from the DSC, after being recreated if necessary).
Hopefully Jan can confirm.
coolguyzone
reviewed
Apr 1, 2025
coolguyzone
approved these changes
Apr 1, 2025
Co-authored-by: Alex Krawiec <[email protected]>
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
When reading the Trace Context docs, I assumed that
client_sample_rate(like all the other fields) was expected to be set by the client. Instead, this field is generated in Relay. If a client sets this field, it will be ignored and overwritten. Added a note to the docs for this field to clarify how it is meant to be used.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: