docs(flutter): Clarify replay with feedback - #19286
Open
sentry-junior[bot] wants to merge 6 commits into
Open
Conversation
Co-Authored-By: Gino Buenaflor <giancarlo.buenaflor@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
The user feedback page duplicated the onErrorSampleRate setup and sampling semantics that the Session Replay page owns. Replace it with a short `### Session Replay` subsection under `SentryFeedbackWidget`, the same placement and depth the Android and Apple user feedback pages use, and cross-link to the replay page instead of restating sampling rules. Also use `SentryFeedbackWidget` in the replay page so the naming matches the rest of the Flutter docs. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
`SentryFeedbackWidget` is a deprecated typedef alias for `SentryFeedbackForm`, so rename the class references and the heading on the user feedback page. Also reduce the Session Replay edits to the factual corrections. The buffer is 30 seconds rather than a minute, per the ring buffer size in develop-docs/sdk/telemetry/replays.mdx, and the feedback form flushes it on open, per develop-docs/sdk/telemetry/feedbacks.mdx. The surrounding sentences go back to the wording the Apple page uses, and the duplicate `onErrorSampleRate` snippet and the redundant platform note are dropped, since the page already documents iOS/Android and SDK `9.0.0` up top. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
`SentryFeedbackForm` only exists in sentry-dart `9.21.0` and later, but the page requires only `9.0.0`, so readers on an earlier 9.x would find no such class. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
buenaflor
marked this pull request as ready for review
September 9, 2026 15:56
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
There are still internal inconsistencies saying replays trigger on feedback “submission” even though the page also states the built-in form flushes when opened / when Sentry.captureFeedback() is called.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the Flutter docs to accurately describe how Session Replay behaves when capturing user feedback, including the rolling buffer duration and when buffered replays get uploaded, and updates naming to match the current SentryFeedbackForm API.
Changes:
- Rename docs references from
SentryFeedbackWidgettoSentryFeedbackForm, including a note about the pre-9.21.0name. - Document that
onErrorSampleRatekeeps a rolling 30-second buffer (not one minute). - Clarify that buffered replays can be flushed for feedback capture, including the built-in feedback form behavior.
File summaries
| File | Description |
|---|---|
| docs/platforms/dart/guides/flutter/user-feedback/index.mdx | Renames the form widget docs and adds a “Session Replay” section explaining the 30-second buffer + feedback-triggered flush behavior. |
| docs/platforms/dart/guides/flutter/session-replay/index.mdx | Updates the “errors only” replay section and sampling text to include buffered replays for feedback and corrects buffer duration to 30 seconds. |
| docs/platforms/dart/guides/flutter/session-replay/configuration.mdx | Updates the onErrorSampleRate config description to reflect feedback-triggered buffered replays and the 30-second buffer. |
Review details
Suppressed comments (1)
docs/platforms/dart/guides/flutter/session-replay/index.mdx:72
- This bullet says
onErrorSampleRatereplays are recorded when a user "submits" feedback, but later in this section the upload trigger is described asSentry.captureFeedback()or the built-in feedback form opening. Align the wording here with the actual triggers to prevent readers from assuming it only happens on submit.
2. `onErrorSampleRate` - The sample rate for replays that are recorded when an error happens or when a user submits feedback. This type of replay will record
up to 30 seconds of events prior to the trigger and continue recording until the session ends.
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Clarifies that Flutter's
onErrorSampleRatekeeps a rolling 30-second replay buffer and sends it for captured feedback. Documents the different trigger timing forSentry.captureFeedback()and the built-in feedback form, which flushes when opened.Also corrects outdated references to a one-minute buffer.
IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
Requested by Gino Buenaflor.
--
View Junior Session [Sentry]