-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(flutter): Document Sentry.runZonedGuarded
#12013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
denrase
merged 7 commits into
getsentry:master
from
denrase:denrase/flutter-sentry-run-zoned-guarded
Dec 17, 2024
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3e2a94b
docs(flutter): Document `Sentry.runZonedGuarded`
denrase e99f58b
Merge branch 'master' into denrase/flutter-sentry-run-zoned-guarded
denrase 8639115
add FlutterWeb with WidgetsBindingIntegration sample tab
denrase 56c1d3e
add async modifier
denrase 7459e8a
Merge branch 'master' into denrase/flutter-sentry-run-zoned-guarded
denrase 64ea81b
pr feedback
denrase bf10465
Update docs
denrase File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,32 @@ | ||
| <PlatformContent includePath="capture-error/dart.mdx" /> | ||
|
|
||
| - Flutter-specific errors, such as using `FlutterError.onError`, are captured automatically | ||
| - The SDK already runs your init `callback` on an error handler, such as [`runZonedGuarded`](https://api.flutter.dev/flutter/dart-async/runZonedGuarded.html) on Flutter versions prior to `3.3`, or [`PlatformDispatcher.onError`](https://api.flutter.dev/flutter/dart-ui/PlatformDispatcher/onError.html) on Flutter versions 3.3 and higher, so that errors are automatically captured. | ||
| ### FlutterError.onError | ||
|
|
||
| Flutter-specific errors, such as using `FlutterError.onError`, are captured automatically. | ||
|
|
||
| ### PlatformDispatcher.onError / runZonedGuarded | ||
|
|
||
| The SDK already runs your init `callback` on an error handler, such as [`runZonedGuarded`](https://api.flutter.dev/flutter/dart-async/runZonedGuarded.html) on Flutter versions prior to `3.3`, or [`PlatformDispatcher.onError`](https://api.flutter.dev/flutter/dart-ui/PlatformDispatcher/onError.html) on Flutter versions 3.3 and higher, so that errors are automatically captured. | ||
buenaflor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If you need a custom error handling zone which also provides automatic error reporting and breadcrumb tracking, use `Sentry.runZonedGuarded`. It wraps Dart's native [`runZonedGuarded`](https://api.flutter.dev/flutter/dart-async/runZonedGuarded.html) function with Sentry-specific functionality. | ||
|
|
||
| This function automatically records calls to `print()` as `Breadcrumbs` and can be configured using `SentryOptions.enablePrintBreadcrumbs`. | ||
|
|
||
| ```dart | ||
| Sentry.runZonedGuarded(() async { | ||
| WidgetsBinding.ensureInitialized(); | ||
| // Errors before init will not be handled by Sentry | ||
| await SentryFlutter.init( | ||
| (options) { | ||
| ... | ||
| }, | ||
| appRunner: () => runApp(MyApp()), | ||
| ); | ||
| } (error, stackTrace) { | ||
| // Automatically sends errors to Sentry, no need to do any | ||
| // captureException calls on your part. | ||
| // On top of that, you can do your own custom stuff in this callback. | ||
| }); | ||
| ``` | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.