docs(dart): Document stream mode in integration guides#18610
Draft
buenaflor wants to merge 4 commits into
Draft
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
Adds a shared “stream mode” callout to Dart/Flutter tracing integration docs so readers understand how transaction references map in stream mode and where to learn more (New Spans).
Changes:
- Added a reusable MDX include (
includes/dart-stream-mode-general-callout.mdx) containing an<Alert>with stream mode guidance. - Inserted that include at the top of 14 Dart/Flutter integration include pages (plus the integrations index) that cover tracing-related behavior.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| includes/dart-stream-mode-general-callout.mdx | New reusable alert explaining stream mode differences and linking to “New Spans”. |
| includes/dart-integrations/index.mdx | Adds the shared stream mode callout to the integrations index include. |
| includes/dart-integrations/app-start-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/asset-bundle-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/dio.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/drift-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/file.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/graphql.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/hive-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/http-integration.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/isar-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/routing-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/slow-and-frozen-frames-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/sqflite-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
| includes/dart-integrations/user-interaction-instrumentation.mdx | Adds the shared stream mode callout near the top of the page. |
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-integrations
branch
from
3536199 to
c69b7c1
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-integrations
branch
from
64e79c2 to
8ec14ee
Compare
6 tasks
buenaflor
changed the title
Add a reusable stream mode callout and include it on the Dart and Flutter integration pages that document tracing. The callout clarifies that transaction references map to service spans in stream mode, that auto-instrumentation switches automatically, and that manual instrumentation uses Sentry.startSpan. Because the integration pages share these includes, one change covers both Dart and Flutter. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Mirror the Python integrations approach: keep the transaction-mode snippet and add an inline 'or, in stream mode: Sentry.startSpan(...)' comment next to each transaction/span creation. Co-Authored-By: Claude <noreply@anthropic.com>
buenaflor
force-pushed
the
buenaflor/docs/dart-span-streaming-integrations
branch
from
8ec14ee to
8e11d88
Compare
Replace the one-line inline stream-mode hints with full dual-mode snippets on the auto-instrumentation includes. Each Verify example now shows a Transaction Mode (Default) tab alongside a Stream Mode tab that wraps the work in `Sentry.startSpan`, so auto-created spans attach to the active span. Behaviour notes now describe both modes. Asset bundle instrumentation still uses the legacy span API and produces no spans in stream mode, so its page keeps a transaction-only snippet with an explicit limitation note instead of a stream tab. Co-Authored-By: Claude <noreply@anthropic.com>
Address Copilot review nit: method names in prose should include parentheses for consistency with other SDK docs. Co-Authored-By: Claude <noreply@anthropic.com>
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 integration guides.
// or, in stream mode: Sentry.startSpan(...)hints next to the transaction/span creation in the integration code snippets (http, dio, file, graphql, sqflite, drift, hive, isar, asset bundle, user interaction), mirroring the Python integrations approachStacked 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: