FlutterFlutter
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
- Flutter and Android encapsulated exceptions (PlatformException)
- Offline storage of events
- Android: Offline caching when a device is offline; we send a report once the application is restarted
- iOS: Offline caching when a device is unable to connect; we send a report once we receive another event
- Events enriched with device data
- Breadcrumbs automatically captured:
- by the Dart SDK
- by the Flutter SDK
- via the Native SDKs Automatic Breadcrumbs for Android and Automatic Breadcrumbs for iOS
- by the Logging Integration
- by the Dio Integration
- by the User Interaction Instrumentation
- Release health tracks crash free users and sessions
- Attachments enrich your event by storing additional files, such as config or log files.
- User Feedback provides the ability to collect user information when an event occurs.
- Performance Monitoring creates transactions for:
- Logging Integration
- Screenshot attachments for errors
- View Hierarchy attachments for errors
- Limited support for Flutter Web, Windows, and Linux
- Under the hood, the SDK relies on the Dart SDK, version
2.17.0and up, and the Flutter SDK, version3.0.0and up.
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.yamldependencies:
sentry_flutter: ^7.7.0Configure
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';
// Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring.
// We recommend adjusting this value in production.
options.tracesSampleRate = 1.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.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
- Package:
- pub:sentry_flutter
- Version:
- 7.7.0
- Repository:
- https://github.com/getsentry/sentry-dart