Dart
Sentry's Dart SDK enables automatic reporting of errors, messages, and exceptions. The SDK is available on GitHub sentry-dart
. For Flutter apps, refer to our Flutter documentation instead.
Features:
- Breadcrumbs automatically captured:
- by the Dart SDK
- by the Logging Integration
- by the Dio Integration
- 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
- Dio Integration
On this page, we get you up and running with Sentry's SDK.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Sentry captures data by using an SDK within your application’s runtime.
pubspec.yaml
dependencies:
sentry: ^8.0.0
Configuration should happen as early as possible in your application's lifecycle.
import 'package:sentry/sentry.dart';
Future<void> main() async {
await Sentry.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;
});
// 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.
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!) or suggesting an update ("yeah, this would be better").
- Package:
- pub:sentry
- Version:
- 8.0.0
- Repository:
- https://github.com/getsentry/sentry-dart
- API Documentation:
- https://pub.dev/documentation/sentry/latest/