Skip to content

docs(dart): Document stream mode in configuration pages - #18609

Merged
buenaflor merged 7 commits into
buenaflor/docs/dart-span-streaming-new-spansfrom
buenaflor/docs/dart-span-streaming-config
Jul 20, 2026
Merged

docs(dart): Document stream mode in configuration pages#18609
buenaflor merged 7 commits into
buenaflor/docs/dart-span-streaming-new-spansfrom
buenaflor/docs/dart-span-streaming-config

Conversation

@buenaflor

@buenaflor buenaflor commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Documents stream mode across the Dart/Flutter configuration pages.

  • options.mdx: new traceLifecycle, beforeSendSpan, and ignoreSpans options (both Dart and Flutter)
  • filtering.mdx: a "Filtering Spans in Stream Mode" section (ignoreSpans + beforeSendSpan)
  • sampling.mdx: notes that a custom tracesSampler receives a span sampling context in stream mode, and that custom sampling context / forcing a decision don't apply
  • Stream-mode notes in sensitive-data and profiling

Stacked 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.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • 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

Copilot AI review requested due to automatic review settings July 1, 2026 09:05
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jul 14, 2026 11:49am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Jul 14, 2026 11:49am

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.spanContext and 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.

Comment thread docs/platforms/dart/common/configuration/options.mdx Outdated
Comment thread docs/platforms/dart/guides/flutter/profiling/index.mdx Outdated
Comment thread docs/platforms/dart/common/configuration/filtering.mdx Outdated
Comment thread docs/platforms/dart/common/configuration/filtering.mdx
@inventarSarah
inventarSarah force-pushed the buenaflor/docs/dart-span-streaming-new-spans branch from 47f4b17 to e3ee6bc Compare July 9, 2026 11:17
@inventarSarah
inventarSarah force-pushed the buenaflor/docs/dart-span-streaming-config branch from bc30c88 to da34ec1 Compare July 9, 2026 11:32
@inventarSarah
inventarSarah marked this pull request as ready for review July 9, 2026 11:38
@buenaflor
buenaflor force-pushed the buenaflor/docs/dart-span-streaming-new-spans branch from e3ee6bc to 522b994 Compare July 14, 2026 11:37
buenaflor and others added 7 commits July 14, 2026 13:37
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
buenaflor merged commit c898c62 into buenaflor/docs/dart-span-streaming-new-spans Jul 20, 2026
9 checks passed
@buenaflor
buenaflor deleted the buenaflor/docs/dart-span-streaming-config branch July 20, 2026 08:41
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
Branch to merge all of span streaming for Dart/Flutter

- #18611
- #18610
- #18609
- #18554

Closes #18655

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: inventarSarah <sarah@codingwriter.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants