ref(javascript): Improve beforeSendSpan documentation
#10907
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 latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Lms24
commented
Jul 30, 2024
| @@ -213,13 +213,15 @@ If the transaction currently being processed has a parent transaction (from an u | |||
|
|
|||
| Learn more about <PlatformLink to="/configuration/sampling/">configuring the sample rate</PlatformLink>. | |||
|
|
|||
| ### Using <PlatformIdentifier name="before-send-transaction" /> | |||
| ### Using `beforeSendTransaction` | |||
There was a problem hiding this comment.
I changed this to the plain string because 1. I don't think <PlatformIdentifier> does anything here since it's a JS-specific docs page and 2. I can't link to this heading properly because of #10613.
Happy to wait with merging this PR until the issue is fixed but I still don't see why we need PlatformIdentifier at all here.
Lms24
requested review from
chargome,
a team and
AbhiPrasad
and removed request for
a team
Bundle ReportChanges will increase total bundle size by 206.85kB ⬆️
|
mydea
approved these changes
Jul 30, 2024
AbhiPrasad
approved these changes
Jul 30, 2024
|
Gonna merge this because it came up today again in an issue. |
Lms24
added a commit
to getsentry/sentry-javascript
that referenced
this pull request
Jul 31, 2024
This PR changes the `beforeSendSpan` JSDoc analogously to the docs change (getsentry/sentry-docs#10907). It now more clearly points out that `beforeSendSpan` is only called for child spans but not for root spans. ref #13119
lforst
pushed a commit
that referenced
this pull request
Aug 2, 2024
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.
This small PR adds a sentence to the existing
beforeSendSpandocumentation that the callback is only applied to child spans andbeforeSendTransactionshould be used to drop entire span trees/transactions. Also reworded the description slightly.Making this change because users seemed to be confused about when
beforeSendSpanis applied.