Breadcrumbs
Sentry uses breadcrumbs to create a trail of events that happened prior to an issue. These events are very similar to traditional logs, but can record more rich structured data.
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the Issue Details page and how you can filter breadcrumbs to quickly resolve issues in Using Breadcrumbs.
Learn about SDK usage
Developers who want to modify the breadcrumbs interface can learn more in our developer documentation about the Breadcrumbs Interface.
You can manually add breadcrumbs whenever something interesting happens. For example, you might manually record a breadcrumb if the user authenticates or another state change occurs.
Manually record a breadcrumb:
import 'package:sentry/sentry.dart';
Sentry.addBreadcrumb(Breadcrumb(message: 'Authenticated user'));
The Flutter SDK already captures breadcrumbs automatically via the Native SDKs for Android, iOS, and macOS.
For platforms where a native SDK is not available, the Flutter SDK automatically uses a WidgetsBindingObserver to record automatic breadcrumbs.
For additional navigation breadcrumbs for Flutter apps, add the
SentryNavigatorObserver
to yourMaterialApp
,WidgetsApp
orCupertinoApp
.
import 'package:flutter/material.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
MaterialApp(
navigatorObservers: [
SentryNavigatorObserver(),
],
// other parameters
)
To track automatic Breadcrumbs for HTTP
requests, check out the SentryHttpClient Wrapper for the http library.
SDKs allow you to customize breadcrumbs through the beforeBreadcrumb
hook.
This hook is passed an already assembled breadcrumb and, in some SDKs, an optional hint. The function can modify the breadcrumb or decide to discard it entirely by returning null
:
import 'package:sentry/sentry.dart';
Breadcrumb beforeBreadcrumb(Breadcrumb breadcrumb, {Hint? hint}) {
return 'a.spammy.Logger' == breadcrumb.category ? null : breadcrumb;
}
Future<void> main() async {
await Sentry.init((options) => options.beforeBreadcrumb = beforeBreadcrumb);
}
For information about what can be done with the hint, see Filtering Events.
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_flutter
- Version:
- 8.0.0
- Repository:
- https://github.com/getsentry/sentry-dart
- API Documentation:
- https://pub.dev/documentation/sentry_flutter/latest/