docs(dart/flutter): Add Span Streaming Docs#18764
Merged
Merged
Conversation
## 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
marked this pull request as draft
July 20, 2026 08:43
|
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
This PR adds and propagates Dart/Flutter documentation for stream mode (span streaming), including new “Streamed Spans” docs + a migration guide, and updates existing tracing/instrumentation/configuration/integration pages to be mode-aware (transaction mode vs stream mode).
Changes:
- Adds new stream mode docs for Dart tracing (
/tracing/streamed-spans/) plus a migration guide. - Updates tracing pages (setup/verify, automatic & custom instrumentation, performance metrics, sampling/filtering/options, sensitive data) to reflect stream mode behavior and limitations.
- Updates Dart/Flutter integration guides and reusable includes with stream mode callouts and “Transaction Mode / Stream Mode” code tabs.
Reviewed changes
Copilot reviewed 60 out of 60 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| platform-includes/performance/uniform-sample-rate/dart.mdx | Clarifies uniform sampling applies to transactions and service spans. |
| platform-includes/performance/uniform-sample-rate/dart.flutter.mdx | Clarifies uniform sampling applies to transactions and service spans (Flutter). |
| platform-includes/performance/traces-sampler-as-sampler/dart.mdx | Adds stream mode tab showing span-based tracesSampler context. |
| platform-includes/performance/traces-sampler-as-sampler/dart.flutter.mdx | Adds stream mode tab showing span-based tracesSampler context (Flutter). |
| platform-includes/performance/span-streaming-enable/dart.mdx | New include snippet to enable stream mode in Dart init. |
| platform-includes/performance/span-streaming-enable/dart.flutter.mdx | New include snippet to enable stream mode in Flutter init. |
| platform-includes/performance/span-streaming-enable-diff/dart.mdx | New diff-style include for enabling stream mode (Dart). |
| platform-includes/performance/span-streaming-enable-diff/dart.flutter.mdx | New diff-style include for enabling stream mode (Flutter). |
| platform-includes/performance/sampling-function-intro/dart.mdx | Adds stream mode note for tracesSampler context. |
| platform-includes/performance/sampling-function-intro/dart.flutter.mdx | Adds stream mode note for tracesSampler context (Flutter). |
| platform-includes/performance/retrieve-transaction/dart.mdx | Updates “retrieve transaction” guidance for stream mode behavior. |
| platform-includes/performance/improving-data/dart.mdx | Adds stream mode attribute APIs and tabbed examples. |
| platform-includes/performance/enable-manual-instrumentation/dart.mdx | Adds stream mode service-span instrumentation tab. |
| platform-includes/performance/custom-performance-metrics/dart.mdx | Explains stream mode measurement workaround via span attributes. |
| platform-includes/performance/connect-errors-spans/dart.mdx | Adds stream mode guidance for error ↔ span linking. |
| platform-includes/performance/add-spans-example/dart.mdx | Adds stream mode nested spans example and semantics. |
| platform-includes/configuration/ignore-transactions/dart.mdx | Updates ignoreTransactions snippet formatting for Dart. |
| platform-includes/configuration/ignore-transactions/dart.flutter.mdx | Adds Flutter ignoreTransactions snippet include. |
| platform-includes/configuration/before-send-transaction/dart.mdx | Adds Dart beforeSendTransaction example include. |
| platform-includes/configuration/before-send-transaction/dart.flutter.mdx | Adds Flutter beforeSendTransaction example include. |
| includes/dart-stream-mode-general-callout.mdx | New reusable stream mode callout for integration pages. |
| includes/dart-integrations/user-interaction-instrumentation.mdx | Adds stream mode callout and stream mode example tab + finishing note. |
| includes/dart-integrations/sqflite-instrumentation.mdx | Adds stream mode callout and stream mode example tab. |
| includes/dart-integrations/slow-and-frozen-frames-instrumentation.mdx | Adds stream mode callout to frames instrumentation page. |
| includes/dart-integrations/routing-instrumentation.mdx | Adds stream mode callout to routing instrumentation page. |
| includes/dart-integrations/isar-instrumentation.mdx | Adds stream mode callout and stream mode example tab. |
| includes/dart-integrations/index.mdx | Adds stream mode callout above integrations index table. |
| includes/dart-integrations/http-integration.mdx | Updates tracing behavior text and adds stream mode example tab. |
| includes/dart-integrations/hive-instrumentation.mdx | Adds stream mode callout and stream mode example tab. |
| includes/dart-integrations/graphql.mdx | Adds stream mode explanation and code tab for decoder-based spans. |
| includes/dart-integrations/file.mdx | Adds stream mode callout and stream mode example tab. |
| includes/dart-integrations/drift-instrumentation.mdx | Adds stream mode callout and stream mode example tab. |
| includes/dart-integrations/dio.mdx | Adds stream mode callout and stream mode example tab. |
| includes/dart-integrations/asset-bundle-instrumentation.mdx | Adds warning that asset bundle instrumentation isn’t stream-mode compatible yet. |
| includes/dart-integrations/app-start-instrumentation.mdx | Adds stream mode callout to app start instrumentation page. |
| docs/platforms/dart/guides/flutter/tracing/trace-propagation/index.mdx | Adds alert that trace continuation isn’t supported in stream mode yet. |
| docs/platforms/dart/guides/flutter/tracing/instrumentation/performance-metrics.mdx | Updates page framing to cover transactions or spans. |
| docs/platforms/dart/guides/flutter/tracing/instrumentation/custom-instrumentation.mdx | Adds alert indicating page covers both modes + links to streamed spans. |
| docs/platforms/dart/guides/flutter/tracing/instrumentation/automatic-instrumentation.mdx | Adds stream mode behavior note and mode-neutral wording updates. |
| docs/platforms/dart/guides/flutter/tracing/index.mdx | Adds stream mode overview and mode-aware sampling/verify wording. |
| docs/platforms/dart/guides/flutter/profiling/index.mdx | Minor formatting cleanup in code fences. |
| docs/platforms/dart/guides/flutter/enriching-events/transaction-name/index.mdx | Adds alert that the page only applies to transaction mode. |
| docs/platforms/dart/guides/flutter/data-management/sensitive-data/index.mdx | Adds beforeSendSpan mention + updates naming guidance for spans. |
| docs/platforms/dart/guides/flutter/configuration/sampling.mdx | Adds stream mode caveats for sampling context/forcing decisions/custom context. |
| docs/platforms/dart/guides/flutter/configuration/options.mdx | Documents traceLifecycle/beforeSendSpan/ignoreSpans + stream mode notes. |
| docs/platforms/dart/guides/flutter/configuration/filtering.mdx | Updates filtering page to cover both transaction and stream mode tools. |
| docs/platforms/dart/common/tracing/trace-propagation/index.mdx | Adds alert that trace continuation isn’t supported in stream mode yet. |
| docs/platforms/dart/common/tracing/trace-propagation/custom-instrumentation/index.mdx | Adds alert scoping trace propagation guide to transaction mode. |
| docs/platforms/dart/common/tracing/streamed-spans/migration-guide.mdx | New migration guide mapping transaction APIs to stream mode span APIs. |
| docs/platforms/dart/common/tracing/streamed-spans/index.mdx | New “Streamed Spans” landing page describing stream mode, APIs, config, and behavior. |
| docs/platforms/dart/common/tracing/instrumentation/performance-metrics.mdx | Updates page framing to cover transactions or spans. |
| docs/platforms/dart/common/tracing/instrumentation/custom-instrumentation.mdx | Adds alert indicating page covers both modes + links to streamed spans. |
| docs/platforms/dart/common/tracing/instrumentation/automatic-instrumentation.mdx | Adds stream mode behavior note and mode-neutral wording updates. |
| docs/platforms/dart/common/tracing/index.mdx | Adds stream mode overview and mode-aware sampling/verify wording. |
| docs/platforms/dart/common/features/index.mdx | Updates feature summary to say tracing captures spans. |
| docs/platforms/dart/common/enriching-events/transaction-name/index.mdx | Adds alert that the page only applies to transaction mode. |
| docs/platforms/dart/common/data-management/sensitive-data/index.mdx | Adds beforeSendSpan mention + updates naming guidance for spans. |
| docs/platforms/dart/common/configuration/sampling.mdx | Adds stream mode caveats for sampling context/forcing decisions/custom context. |
| docs/platforms/dart/common/configuration/options.mdx | Documents traceLifecycle/beforeSendSpan/ignoreSpans + stream mode notes. |
| docs/platforms/dart/common/configuration/filtering.mdx | Updates filtering page to cover both transaction and stream mode tools. |
Clarify which tracing APIs apply in each mode and make integration guidance explicit. Fix the stream mode link and sampling context typos. Refs #18764 Co-Authored-By: Claude <noreply@anthropic.com>
Name every public stream mode span API so the static-mode limitation is complete. Refs #18764 Co-Authored-By: Claude <noreply@anthropic.com>
buenaflor
marked this pull request as ready for review
July 20, 2026 12:55
…-flutter-span-streaming
Align the Dart guide with the JavaScript span streaming flow and examples. Add migration steps, shared attributes, trace propagation guidance, and the agent-assisted migration prompt. Co-Authored-By: Claude <noreply@anthropic.com>
Remove the extra lifecycle and span-dropping note from the streamed spans guide. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
@cleptric removed the line we discussed, should be good to go now |
inventarSarah
approved these changes
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.
Branch to merge all of span streaming for Dart/Flutter
Closes #18655