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
SentrySdk.AddBreadcrumb(
    message: "Authenticated user " + user.Email,
    category: "auth",
    level: BreadcrumbLevel.Info);

The .NET SDK captures breadcrumbs automatically for:

  • HTTP requests made using HttpClient are captured automatically when using SentryHttpMessageHandler. See HTTP Client Errors for setup instructions.

  • Logs

  • Database Queries

  • MAUI Application Events

    • For MAUI applications, the SDK captures application lifecycle and user interaction events including navigation, window lifecycle, element rendering, and user actions.
  • GraphQL Requests

    • When using SentryGraphQLHttpMessageHandler GraphQL requests are captured as breadcrumbs, including query type, operation name, and performance data.

The SDK allows you to customize breadcrumbs through the BeforeBreadcrumb hook.

This hook is passed an already assembled breadcrumb and, optionally, a hint object containing extra metadata. The function can modify the breadcrumb or decide to discard it entirely by returning null:

Copied
// Add this to the SDK initialization callback
options.SetBeforeBreadcrumb(breadcrumb
    // Ignore breadcrumbs from Spammy logger
    => breadcrumb.Category == "Spammy.Logger"
        ? null
        : breadcrumb);
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").