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:
from sentry_sdk import add_breadcrumb add_breadcrumb( category='auth', message='Authenticated user %s' % user.email, level='info', )
The available breadcrumb keys are
timestamp (which many SDKs will set automatically for you), and
data, which is the place to put any additional information you'd like the breadcrumb to include. Using keys other than these six won't cause an error, but will result in the data being dropped when the event is processed by Sentry.
SDKs allow you to customize breadcrumbs through the
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
import sentry_sdk def before_breadcrumb(crumb, hint): if crumb['category'] == 'a.spammy.Logger': return None return crumb sentry_sdk.init( # ... before_breadcrumb=before_breadcrumb, )
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!) to suggesting an update ("yeah, this would be better").