docs(js): Update Extended Configuration pages for stream mode#17879
Draft
inventarSarah wants to merge 3 commits into
Draft
docs(js): Update Extended Configuration pages for stream mode#17879inventarSarah wants to merge 3 commits into
inventarSarah wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
inventarSarah
commented
May 26, 2026
| { name: 'startTime', type: 'number', description: 'The timestamp to use for the span start. If not provided, the current time will be used.' }, | ||
| { name: 'op', type: 'string', description: 'The operation name for the span. This is used to group spans in the UI' }, | ||
| { name: 'forceTransaction', type: 'boolean', description: 'If true, the span will be forced to be sent as a transaction, even if it is not the root span.' }, | ||
| { name: 'forceTransaction', type: 'boolean', description: 'If true, the span will be forced to be sent as a transaction, even if it is not the root span. \n// Not available in stream mode. Use `parentSpan: null` instead to make this span show up as service span.' }, |
Collaborator
Author
There was a problem hiding this comment.
Adding "\n" like this works, but I am not sure if it's "allowed" ;)
{ ... description: 'If true,... \n// Not available in stream mode. Use `parentSpan: null` instead to make this span show up as service span.' },
inventarSarah
requested review from
Lms24,
chargome,
cleptric,
mydea and
sfanahata
sfanahata
reviewed
May 26, 2026
| ```javascript {tabTitle:Stream Mode} | ||
| Sentry.init({ | ||
| dsn: "___PUBLIC_DSN___", | ||
| beforeSendSpan(span) { |
Contributor
There was a problem hiding this comment.
Should this include the Sentry.withStreamedSpan() wrapper?
Collaborator
Author
There was a problem hiding this comment.
Yes, it should -- updated 👍
sfanahata
reviewed
May 26, 2026
| | Transaction Mode (`SpanJSON`) | Stream Mode (`StreamedSpanJSON`) | | ||
| | ---------------------------------- | ----------------------------------- | | ||
| | `span.description` | `span.name` | | ||
| | `span.data` (processed attributes) | `span.attributes` (raw attributes) | |
Contributor
There was a problem hiding this comment.
Should we add more about name and span.op here, like we do in filtering?
Collaborator
Author
There was a problem hiding this comment.
I added an Expandable with the code examples from the Filtering page below -- or did you mean something different?
sfanahata
reviewed
May 26, 2026
|
|
||
| - `'manual'` (default): You control when profiling starts and stops using the `startProfiler()` and `stopProfiler()` functions. In this mode, profile sampling is only affected by `profileSessionSampleRate`.<PlatformSection notSupported={["javascript.bun", "javascript.cordova", "javascript.capacitor", "javascript.deno", "javascript.cloudflare"]}> Read more about these functions in the <PlatformLink to="/profiling">profiling API documentation</PlatformLink>.</PlatformSection> | ||
| - `'trace'`: Profiling starts and stops automatically with transactions, as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both `profileSessionSampleRate` and your tracing sample rate (`tracesSampleRate` or `tracesSampler`). | ||
| - `'trace'`: Profiling starts and stops automatically with transactions (or service span if you're using <PlatformLink to="/tracing/new-spans">stream mode</PlatformLink>), as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both `profileSessionSampleRate` and your tracing sample rate (`tracesSampleRate` or `tracesSampler`). |
Contributor
There was a problem hiding this comment.
Suggested change
| - `'trace'`: Profiling starts and stops automatically with transactions (or service span if you're using <PlatformLink to="/tracing/new-spans">stream mode</PlatformLink>), as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both `profileSessionSampleRate` and your tracing sample rate (`tracesSampleRate` or `tracesSampler`). | |
| - `'trace'`: Profiling starts and stops automatically with transactions (or service spans if you're using <PlatformLink to="/tracing/new-spans">stream mode</PlatformLink>), as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both `profileSessionSampleRate` and your tracing sample rate (`tracesSampleRate` or `tracesSampler`). |
sfanahata
reviewed
May 26, 2026
| If you want to drop the transaction/service span, including its child spans: | ||
|
|
||
| - Use [`beforeSendTransaction`](#using-beforesendtransaction) in transaction mode. | ||
| - Use [`ignoreSpans`](#using-ignore-spans) in stream mode. |
Contributor
There was a problem hiding this comment.
Do we need to mention the withStreamedSpan() wrapper here too?
Collaborator
Author
There was a problem hiding this comment.
thank you, great catch!
-> added wrapper info
sfanahata
approved these changes
May 26, 2026
Contributor
sfanahata
left a comment
sfanahata
left a comment
There was a problem hiding this comment.
Content wise this looks fine, with a couple of questions about adding/referencing the same info across these pages. See comments for details.
…an-first/js-config-updates
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This branch contains updated APIs, Options, and Filter page content for stream mode/new spans.
The PR is currently in Draft because we have two additional PRs open, which cover the same content. I will update this branch with any feedback on these PRs before marking it ready for review.
Closes: #17837
Important
Must only be merged after #17834
This branch is separate from this PR and thus does not contain the new /tracing/new-spans page. However, this branch adds links to that page, which the 404 Linter identifies correctly as broken
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:
EXTRA RESOURCES