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
Sentry.Context.add_breadcrumb(%{
  category: "web.liveview.phx_click",
  message: "click happened",
  level: :info
})

The available breadcrumb keys are type, category, message, level, 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.

SDK 和其关联的集成会自动记录许多类型的面包屑。例如,浏览器 JavaScript SDK 会自动记录 DOM 元素上的点击和按键事件、XHR/fetch 请求、控制台 API 调用以及所有位置变化。