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.

Manual Breadcrumbs

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:

Copied
import io.sentry.Breadcrumb;
import io.sentry.Sentry;
import io.sentry.SentryLevel;

Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setCategory("auth");
breadcrumb.setMessage("Authenticated user " + user.getEmail());
breadcrumb.setLevel(SentryLevel.INFO);
Sentry.addBreadcrumb(breadcrumb);

Automatic Breadcrumbs

The Android SDK captures breadcrumbs automatically. To track automatic breadcrumbs for HTTP requests, check out the OkHttp Interceptor for the OkHttp library.

Customize Breadcrumbs

SDKs allow you to customize breadcrumbs through the before_breadcrumb 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:

Copied
import io.sentry.android.core.SentryAndroid;

SentryAndroid.init(this, options -> {
  options.setBeforeBreadcrumb((breadcrumb, hint) -> {
    if ("a.spammy.Logger".equals(breadcrumb.getCategory())) {
      return null;
    } else {
      return breadcrumb;
    }
  });
});

Disable Automatic Breadcrumbs

If you want to disable the automatic collection of breadcrumbs, please add the following items into your manifest.

Copied
<application>
    <!-- To disable the activity lifecycle breadcrumbs integration -->
    <meta-data android:name="io.sentry.breadcrumbs.activity-lifecycle" android:value="false" />

    <!-- To disable the app lifecycle breadcrumbs integration -->
    <meta-data android:name="io.sentry.breadcrumbs.app-lifecycle" android:value="false" />

    <!-- To disable the system events breadcrumbs integration -->
    <meta-data android:name="io.sentry.breadcrumbs.system-events" android:value="false" />

    <!-- To disable the app components breadcrumbs integration -->
    <meta-data android:name="io.sentry.breadcrumbs.app-components" android:value="false" />
</application>

For information about what can be done with the hint, see Filtering Events.

Help improve this content
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").