docs(flutter): Document beforeCapture function customization
#12190
Conversation
This file contains 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
|
@denrase is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
buenaflor
reviewed
Jan 2, 2025
|
|
||
| <Note> | ||
|
|
||
| Requires SDK version `8.12.0` or higher. |
There was a problem hiding this comment.
we released 8.12.0 already
Suggested change
| Requires SDK version `8.12.0` or higher. | |
| Requires SDK version `8.13.0` or higher. |
Comment on lines
+41
to
+43
| if (debounce) { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
iirc that means that users can also skip debouncing if they return true anyway, right?
|
|
||
| </Note> | ||
|
|
||
| Because capturing view hierarchy can be a resource-intensive operation on Flutter, it's limited to one view hierarchy every 2 seconds using a debouncing mechanism. This behavior can be overruled if you supply a `BeforeCaptureCallback` for view hierarchies in the `SentryFlutterOptions`. |
There was a problem hiding this comment.
Suggested change
| Because capturing view hierarchy can be a resource-intensive operation on Flutter, it's limited to one view hierarchy every 2 seconds using a debouncing mechanism. This behavior can be overruled if you supply a `BeforeCaptureCallback` for view hierarchies in the `SentryFlutterOptions`. | |
| Capturing view hierarchies on Flutter is limited to once every 2 seconds by default to minimize performance impact. While this debounce interval is fixed, you can override individual capture decisions by implementing the `beforeCaptureViewHierarchy` option in your `SentryFlutterOptions`. |
|
|
||
| </Note> | ||
|
|
||
| Because capturing screenshots can be a resource-intensive operation on Flutter, it's limited to one screenshot every 2 seconds using a debouncing mechanism. This behavior can be overruled if you supply a `BeforeCaptureCallback` for screenshots in the `SentryFlutterOptions`. |
There was a problem hiding this comment.
Suggested change
| Because capturing screenshots can be a resource-intensive operation on Flutter, it's limited to one screenshot every 2 seconds using a debouncing mechanism. This behavior can be overruled if you supply a `BeforeCaptureCallback` for screenshots in the `SentryFlutterOptions`. | |
| Capturing screenshots on Flutter is limited to once every 2 seconds by default to minimize performance impact. While this debounce interval is fixed, you can override individual capture decisions by implementing the `beforeCaptureScreenshot` option in your `SentryFlutterOptions`. |
|
|
||
| The `BeforeCaptureCallback` also allows you to customize the behavior based on event data, so you can decide when to capture a screenshot and when not to. For example, you can decide to only capture screenshots of fatal events: | ||
|
|
||
| ```java |
There was a problem hiding this comment.
Suggested change
| ```java | |
| ```dart |
There was a problem hiding this comment.
also please add line highlighting
|
|
||
| ```java | ||
| await SentryFlutter.init((options) { | ||
| options.attachScreenshot = true; |
There was a problem hiding this comment.
Suggested change
| options.attachScreenshot = true; |
I guess we can remove this as we can assume screenshots are already in place
|
|
||
| ```java | ||
| await SentryFlutter.init((options) { | ||
| options.attachViewHierarchy = true; |
There was a problem hiding this comment.
Suggested change
| options.attachViewHierarchy = true; |
|
|
||
| The `BeforeCaptureCallback` also allows you to customize behavior based on event data so you can decide when to capture view hierarchy and when not to. For example, you can decide to only capture view hierarchy for fatal events: | ||
|
|
||
| ```java |
There was a problem hiding this comment.
Suggested change
| ```java | |
| ```dart |
pls add line highlighting
|
|
||
| Because capturing view hierarchy can be a resource-intensive operation on Flutter, it's limited to one view hierarchy every 2 seconds using a debouncing mechanism. This behavior can be overruled if you supply a `BeforeCaptureCallback` for view hierarchies in the `SentryFlutterOptions`. | ||
|
|
||
| The `BeforeCaptureCallback` also allows you to customize behavior based on event data so you can decide when to capture view hierarchy and when not to. For example, you can decide to only capture view hierarchy for fatal events: |
There was a problem hiding this comment.
Suggested change
| The `BeforeCaptureCallback` also allows you to customize behavior based on event data so you can decide when to capture view hierarchy and when not to. For example, you can decide to only capture view hierarchy for fatal events: | |
| The `beforeCaptureViewHierarchy` option allows you to customize behavior based on event data so you can decide when to capture view hierarchy and when not to. For example, you can decide to only capture view hierarchy for fatal events: |
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
Adds docs for using the before capture callbacks for screenshots and view hierarchy.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
EXTRA RESOURCES