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 happens.

Copied
Raven.breadcrumbs.record do |crumb|
  crumb.category = "auth"
  crumb.message = "Authenticated user #{user.email}"
  crumb.level = "info"
end

Appropriate places to inject Breadcrumbs may be places like your HTTP library:

Copied
# Instrumenting Faraday with a middleware:

class RavenFaradayMiddleware
  def call
    # Add a breadcrumb every time we complete an HTTP request
    @app.call(request_env).on_complete do |response_env|
      Raven.breadcrumbs.record do |crumb|
        crumb.data = { response_env: response_env }
        crumb.category = "faraday"
        crumb.timestamp = Time.now.to_i
        crumb.message = "Completed request to #{request_env[:url]}"
      end
    end
  end
end

Automatic Breadcrumbs

SDKs will automatically start recording breadcrumbs by enabling integrations. For instance, the browser JavaScript SDK will automatically record all location changes.

The platform or SDK you've selected either does not support this functionality, or it is missing from documentation.

If you think this is an error, feel free to let us know on GitHub.

Customize Breadcrumbs

SDKs customize breadcrumbs through the before_breadcrumb hook. This hook passes an already assembled breadcrumb and, in some SDKs, an optional hint. The function can modify the breadcrumb or decide to discard it entirely:

For information about what can be done with the hint, see Filtering Events.

You can edit this page on GitHub.