docs(dart): Document stream mode in configuration pages - #18609
Merged
buenaflor merged 7 commits intoJul 20, 2026
Merged
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
marked this pull request as draft
July 1, 2026 09:11
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
July 1, 2026 10:23
77a12de to
7328412
Compare
buenaflor
changed the base branch from
master
to
buenaflor/docs/dart-span-streaming-new-spans
July 1, 2026 10:23
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
July 6, 2026 12:36
93cbe73 to
d291d3b
Compare
6 tasks
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
July 6, 2026 13:43
d291d3b to
ad6539b
Compare
inventarSarah
force-pushed
the
buenaflor/docs/dart-span-streaming-new-spans
branch
from
July 9, 2026 11:17
47f4b17 to
e3ee6bc
Compare
inventarSarah
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
July 9, 2026 11:32
bc30c88 to
da34ec1
Compare
inventarSarah
marked this pull request as ready for review
July 9, 2026 11:38
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-new-spans
branch
from
July 14, 2026 11:37
e3ee6bc to
522b994
Compare
Document stream mode (SentryTraceLifecycle.stream) for the Dart and Flutter SDKs, where spans are sent as they finish instead of being batched into a transaction. Mirrors the Python New Spans pages. - New Spans page: enabling stream mode, manual instrumentation with startSpan/startSpanSync/startInactiveSpan, typed attributes, status, beforeSendSpan/ignoreSpans, sampling, and verification - Migration guide: mapping transaction-based APIs to the new span APIs - Platform-includes split init snippets for Flutter vs plain Dart Co-Authored-By: Claude <noreply@anthropic.com>
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>
Add beforeSendTransaction and ignoreTransactions guidance to the Dart and Flutter filtering pages. Explain how to migrate transaction filters to ignoreSpans in stream mode. Co-Authored-By: Claude <noreply@anthropic.com>
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-config
branch
from
July 14, 2026 11:38
2f7ddbb to
dee1a7a
Compare
inventarSarah
approved these changes
Jul 16, 2026
buenaflor
merged commit Jul 20, 2026
c898c62
into
buenaflor/docs/dart-span-streaming-new-spans
9 checks passed
buenaflor
added a commit
that referenced
this pull request
Jul 20, 2026
## DESCRIBE YOUR PR Introduces the Dart/Flutter **stream mode** (span streaming) documentation — the base of a 4-PR stack. Mirrors the Python New Spans docs. - New **New Spans** page: enabling stream mode (`traceLifecycle: SentryTraceLifecycle.stream`), manual instrumentation (`startSpan`/`startSpanSync`/`startInactiveSpan`), typed `SentryAttribute` attributes (including array factories), span status, `beforeSendSpan`/`ignoreSpans`, sampling, and verification - New **Migrate to Stream Mode** guide mapping the transaction API to the new span API - Minimum SDK version documented as `9.23.0` This is the bottom of the stack — merge this first. Stacked children: #18609, #18610, #18611. Ref: getsentry/sentry-dart#3886 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: inventarSarah <sarah@codingwriter.com>
buenaflor
added a commit
that referenced
this pull request
Jul 21, 2026
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.
Ref: getsentry/sentry-dart#3886
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: