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.
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:
SentrySdk.AddBreadcrumb(
message: "Authenticated user " + user.Email,
category: "auth",
level: BreadcrumbLevel.Info);
SDK 和其关联的集成会自动记录许多类型的面包屑。例如,浏览器 JavaScript SDK 会自动记录 DOM 元素上的点击和按键事件、XHR/fetch 请求、控制台 API 调用以及所有位置变化。
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
:
// Add this to the SDK initialization callback
options.SetBeforeBreadcrumb(breadcrumb
// Ignore breadcrumbs from Spammy logger
=> breadcrumb.Category == "Spammy.Logger"
? null
: breadcrumb);