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:

\Sentry\addBreadcrumb(
    category: 'auth',
    message: 'User authenticated', // optional
    metadata: ['user_id' => $userId], // optional
    level: Breadcrumb::LEVEL_INFO, // set by default
    type: Breadcrumb::TYPE_DEFAULT, // set by default
);

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.

Automatic Breadcrumbs

SDKs and their associated integrations will automatically record many types of breadcrumbs. For example, the browser JavaScript SDK will automatically record clicks and key presses on DOM elements, XHR/fetch requests, console API calls, and all location changes.

Customize Breadcrumbs

SDKs allow you to customize breadcrumbs through the before_breadcrumb 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:

sentry:
  options:
    before_breadcrumb: 'sentry.callback.before_breadcrumb'

services:
  sentry.callback.before_breadcrumb:
    class: 'App\Service\Sentry'
    factory: ['@App\Service\Sentry', 'getBeforeBreadcrumb']

The service needed for the before_breadcrumb option can be implemented as follows:

<?php

namespace App\Service;

class Sentry
{
    public function getBeforeBreadcrumb(): callable
    {
        return function(\Sentry\Breadcrumb $breadcrumb): ?\Sentry\Breadcrumb {
            return $breadcrumb;
        };
    }
}

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