Flutter
Sentry's Flutter SDK enables automatic reporting of errors, messages, and exceptions. The SDK is available on GitHub sentry-dart
.
Features:
- Automatic native crash error tracking (using both Android and iOS/macOS), including
- Java, Kotlin, C, and C++ code for Android
- ObjC, Swift, and C for iOS and macOS
- Offline storage of events
- Events enriched with device data
- Breadcrumbs automatically captured:
- by the Flutter SDK
- via the Native SDKs Automatic Breadcrumbs for Android and Automatic Breadcrumbs for iOS
- as well as
http
with the Dart SDK
- Release Health tracks crash free users and sessions
- Limited support for Flutter Web, Windows, and Linux
- Under the hood the SDK relies on the Dart SDK; the minimum required version is
2.12.0
and Flutter SDK version is1.17.0
.
On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Install
Sentry captures data by using an SDK within your application’s runtime.
pubspec.yaml
dependencies:
sentry_flutter: ^8.6.0
Configure
Configuration should happen as early as possible in your application's lifecycle.
import 'package:flutter/widgets.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
Future<void> main() async {
await SentryFlutter.init(
(options) => options.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0',
appRunner: () => runApp(MyApp()),
);
// or define SENTRY_DSN via Dart environment variable (--dart-define)
}
You can configure the SENTRY_DSN
, SENTRY_RELEASE
, SENTRY_DIST
and SENTRY_ENVIRONMENT
via the Dart environment variables passing the --dart-define
flag to the compiler as noted in the code sample.
Verify
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:
import 'package:sentry/sentry.dart';
try {
aMethodThatMightFail();
} catch (exception, stackTrace) {
await Sentry.captureException(
exception,
stackTrace: stackTrace,
);
}
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
- Package:
- pub:sentry_flutter
- Version:
- 8.6.0
- Repository:
- https://github.com/getsentry/sentry-dart