Breadcrumbs

Learn more about what Sentry uses to create a trail of events (breadcrumbs) that happened prior to an issue.

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.

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
use sentry::{add_breadcrumb, Breadcrumb, Level};

add_breadcrumb(Breadcrumb {
    category: Some("auth".into()),
    message: Some(format!("Authenticated user {}", user.email)),
    level: Level::Info,
    ..Default::default()
});

Breadcrumbs are recorded automatically out of TRACE and DEBUG level events/records when using the integrations for the tracing and log crates respectively.

Previous
Enriching Events
Next
Context
Was this helpful?
Help improve this content
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").