docs(native): Document user feedback scope data and before_send_feedback - #18982
Open
limbonaut wants to merge 6 commits into
Open
Conversation
Feedback gained scope data in 0.16.0 and a dedicated filtering hook in 0.16.2, none of which was documented. The user feedback page still showed only a bare `sentry_capture_feedback` call. - Note that feedback carries the global scope's release, environment, tags, user, and contexts including the trace, plus scope attachments, since 0.16.0. Breadcrumbs, modules, and stack traces are left off. - Document `sentry_scope_capture_feedback` (0.16.0) and hints for attaching files to a single feedback. - Add the `before_send_feedback` option and a Filtering section for it. Feedback does not pass through `before_send`, so this is the only hook that sees it. - Flag `sentry_value_new_user_feedback` and `sentry_capture_user_feedback` as deprecated; they emit the older User Report item, which carries neither scope data nor attachments. - Document `sentry_scope_remove_fingerprint` (0.16.2). NOTE: `before_send_feedback` and `sentry_scope_remove_fingerprint` are unreleased. Hold this PR until 0.16.2 ships, and confirm the version number before merging. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Collaborator
Author
|
Code samples are verified. |
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
1 participant
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.
Documents what user feedback carries and how to control it in the Native SDK: the global scope data attached to a feedback event, attaching files through a hint, capturing feedback with a scope, and filtering with the
before_send_feedbackhook. The hook receives a feedback event with the feedback nested undercontexts.feedback, so the filtering example reads it from there and releases the event when dropping it.before_send_feedbackhook sentry-native#1923sentry_scope_remove_fingerprintsentry-native#1932IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: