Breadcrumbs

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.

Manual 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:

SentrySdk.AddBreadcrumb(
    message: "Authenticated user " + user.Email,
    category: "auth",
    level: BreadcrumbLevel.Info);

Automatic Breadcrumbs

The Unity SDK captures breadcrumbs automatically for:

• Unity Logs

  • Unity logs from the built-in logging system are captured when using the default UnityApplicationLoggingIntegration:
  • Debug.Log (captured at Info level)
  • Debug.LogWarning (captured at Warning level)
  • Debug.LogError and Debug.LogAssert (captured at Error level)

• Scene Events

• Scene events are captured when using SceneManagerIntegration:

• Scene loaded

• Scene unloaded

• Active scene changed

• Application Lifecycle Events

  • These are captured when AutoSessionTracking is enabled (default):
  • Application entering foreground (triggered by focus gain or unpause)
  • Application entering background (triggered by focus loss or pause)

• Low Memory Warnings

  • Low memory warnings from Unity's system events are captured automatically when using LowMemoryIntegration.

• Native Platform Breadcrumbs

  • Captured when native support is enabled (default for Android, iOS, macOS, and other platforms):
  • Android: Activity lifecycle, system events, user interactions, and HTTP requests via the Sentry Android SDK
  • iOS/macOS: Application lifecycle, UIControl events, system events (battery, memory, orientation), and HTTP requests via the Sentry Cocoa SDK
  • Other platforms: Native crash handling and scope synchronization via sentry-native

Customize Breadcrumbs

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);