---
title: "Breadcrumbs"
description: "Learn more about what Sentry uses to create a trail of events (breadcrumbs) that happened prior to an issue."
url: https://docs.sentry.io/platforms/php/guides/symfony/enriching-events/breadcrumbs/
---

# Breadcrumbs | Sentry for Symfony

##### Hey... did you mean Logs? Sentry has them now!

Manual breadcrumbs had a good run, but [Sentry's got logs](https://docs.sentry.io/platforms/php/guides/symfony/logs.md). Structured, searchable, and way easier to alert or query on. Check them out!

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](https://docs.sentry.io/product/error-monitoring/breadcrumbs.md).

##### Learn about SDK usage

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/foundations/transport/event-payloads/breadcrumbs/).

## [Manual Breadcrumbs](https://docs.sentry.io/platforms/php/guides/symfony/enriching-events/breadcrumbs.md#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:

```php
\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 defaults to the system's wall-clock time), 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](https://docs.sentry.io/platforms/php/guides/symfony/enriching-events/breadcrumbs.md#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](https://docs.sentry.io/platforms/php/guides/symfony/enriching-events/breadcrumbs.md#customize-breadcrumbs)

SDKs allow you to customize breadcrumbs through the `before_breadcrumb` hook.

This hook is passed an already assembled breadcrumb. The function can modify the breadcrumb or decide to discard it entirely by returning `null`:

`config/packages/sentry.yaml`

```yaml
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:

`src/Service/Sentry.php`

```php
<?php

namespace App\Service;

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

Learn more in [Callables in Symfony Options](https://docs.sentry.io/platforms/php/guides/symfony/configuration/symfony-options.md#callables).

For information about what can be done with the hint, see [Filtering Events](https://docs.sentry.io/platforms/php/guides/symfony/configuration/filtering.md#using-hints).