fix(apple): Clarify trace propagation targets #9110
Merged
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
The trace propagation target code sample was in the section of distributed tracing without an explanation, making the distributed tracing docs for Apple confusing. This is fixed now by adding an explanation and moving the trace propagation target below the distributed tracing section.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
kahest
reviewed
Feb 12, 2024
docs/platforms/apple/common/usage/distributed-tracing/index.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/apple/common/usage/distributed-tracing/index.mdx
Outdated
Show resolved
Hide resolved
| You can put string or regexes into the allowlist, and the SDK then only attaches the `sentry-trace` and `baggage` | ||
| headers to all outgoing requests whose destination contains a string in the list or matches a regex in the list. | ||
|
|
||
| **The `tracePropagationTargets` option matches the entire request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests don't unnecessarily have additional headers attached.** |
There was a problem hiding this comment.
Suggested change
| **The `tracePropagationTargets` option matches the entire request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests don't unnecessarily have additional headers attached.** | |
| **Because the `tracePropagationTargets` option matches the entire request URL, not just the domain, you should use strict regexes that match specific parts of the URL to ensure that requests don't have unnecessary or unwanted headers attached.** |
There was a problem hiding this comment.
I think it would be good to turn this into a note rather than bolding it.
lizokm
approved these changes
Feb 13, 2024
docs/platforms/apple/common/usage/distributed-tracing/index.mdx
Outdated
Show resolved
Hide resolved
| You can put string or regexes into the allowlist, and the SDK then only attaches the `sentry-trace` and `baggage` | ||
| headers to all outgoing requests whose destination contains a string in the list or matches a regex in the list. | ||
|
|
||
| **The `tracePropagationTargets` option matches the entire request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests don't unnecessarily have additional headers attached.** |
There was a problem hiding this comment.
I think it would be good to turn this into a note rather than bolding it.
docs/platforms/apple/common/usage/distributed-tracing/index.mdx
Outdated
Show resolved
Hide resolved
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Pre-merge checklist
If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.
Description of changes
The trace propagation target code sample was in the section of distributed tracing without an explanation, making the distributed tracing docs for Apple confusing. This is fixed now by adding an explanation and moving the trace propagation target below the distributed tracing section.