docs(dart): Document stream mode in configuration pages#18609
Draft
buenaflor wants to merge 3 commits into
Draft
docs(dart): Document stream mode in configuration pages#18609buenaflor wants to merge 3 commits into
buenaflor wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documents Dart/Flutter “stream mode” (span streaming) behavior across existing Configuration and data-management pages, aligning Dart/Flutter guidance with the corresponding Python documentation effort and the new span APIs introduced in sentry-dart 9.19.0.
Changes:
- Adds Stream Mode configuration options (
traceLifecycle,beforeSendSpan,ignoreSpans) to Options pages (common + Flutter override). - Adds stream-mode-specific guidance to Sampling, Filtering, and Sensitive Data pages (including
samplingContext.spanContextand span scrubbing). - Notes feature limitations in stream mode (profiling unavailable) on the Flutter Profiling page.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/platforms/dart/guides/flutter/profiling/index.mdx | Adds a warning that profiling is not available in stream mode. |
| docs/platforms/dart/guides/flutter/data-management/sensitive-data/index.mdx | Adds stream-mode span scrubbing guidance via beforeSendSpan and link to New Spans. |
| docs/platforms/dart/guides/flutter/configuration/sampling.mdx | Adds stream-mode callout about tracesSampler sampling context (samplingContext.spanContext). |
| docs/platforms/dart/guides/flutter/configuration/options.mdx | Documents stream-mode options (traceLifecycle, beforeSendSpan, ignoreSpans) and sampling-context note. |
| docs/platforms/dart/guides/flutter/configuration/filtering.mdx | Adds a stream-mode section describing span filtering/modification using ignoreSpans/beforeSendSpan. |
| docs/platforms/dart/common/data-management/sensitive-data/index.mdx | Same stream-mode sensitive data guidance for the common Dart pages. |
| docs/platforms/dart/common/configuration/sampling.mdx | Same stream-mode sampling-context callout for the common Dart pages. |
| docs/platforms/dart/common/configuration/options.mdx | Same stream-mode options and sampling-context note for the common Dart pages. |
| docs/platforms/dart/common/configuration/filtering.mdx | Same stream-mode filtering section for the common Dart pages. |
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
77a12de to
7328412
Compare
buenaflor
changed the base branch from
master
to
buenaflor/docs/dart-span-streaming-new-spans
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
93cbe73 to
d291d3b
Compare
6 tasks
Add the stream mode configuration options (traceLifecycle, beforeSendSpan, ignoreSpans) to the Options pages, and cover stream mode behavior in the filtering, sampling, sensitive-data, and profiling pages for both Dart and Flutter. Note that a custom tracesSampler receives a different sampling context and that profiling is unavailable in stream mode. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Custom sampling context and forcing a sampling decision don't exist in stream mode; note that data should be passed as span attributes and read via samplingContext.spanContext in a tracesSampler instead. Co-Authored-By: Claude <noreply@anthropic.com>
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
d291d3b to
ad6539b
Compare
|
|
||
| <Alert level="warning"> | ||
|
|
||
| Profiling isn't available in stream mode. It works only with the default transaction mode (`SentryTraceLifecycle.static`). |
Collaborator
There was a problem hiding this comment.
Does it make sense to you to also add this to the main page (New Spans) and display it only for Flutter?
Contributor
Author
There was a problem hiding this comment.
Actually, I think we should remove this. the profiling we have in Flutter is only Alpha and might be removed soon
Collaborator
There was a problem hiding this comment.
Okay, then I'll remove this warning
|
|
||
| <Alert level="warning"> | ||
|
|
||
| The options above apply to transactions. In stream mode there are no transactions — use `ignoreSpans` to drop spans and `beforeSendSpan` to modify them. See <PlatformLink to="/tracing/new-spans/#extended-configuration-optional">New Spans</PlatformLink> for details. |
Collaborator
There was a problem hiding this comment.
"The options above apply to transactions."
Does this also apply to the "Using tracesSampler" section?
Contributor
Author
There was a problem hiding this comment.
tracesSampler also works for span streaming. I guess this is confusingly worded
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
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
Documents stream mode across the Dart/Flutter configuration pages.
options.mdx: newtraceLifecycle,beforeSendSpan, andignoreSpansoptions (both Dart and Flutter)filtering.mdx: a "Filtering Spans in Stream Mode" section (ignoreSpans+beforeSendSpan)sampling.mdx: notes that a customtracesSamplerreceives a span sampling context in stream mode, and that custom sampling context / forcing a decision don't applyStacked on #18554 — review/merge that first.
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: