classmarkets/raven-bundle

Display sentry event ids on error pages

raven-bundle

, _(*1)

Are you using sentry for exception monitoring in Symfony 2? Good! Now let's show meaningful error pages to your users., _(*2)

Sentry generates ids for each event it receives. This bundle adds a Twig function that let's you access those event ids in error page templates:, _(*3)

Oh no, something went wrong!



{% if exception is defined %}
    {% set eventId = sentry_event_id(exception) %}

    {% if eventId is not empty %}
        <p>
            The good news is that our team has been notified and is probably
            working on a solution already.
        </p>

        <p>
            Error Code: <code>{{ eventId }}</code>
        </p>
    {% endif %}
{% endif %}

You can also lookup event ids wherever the DIC is available like this:, _(*4)

<?php

$container->get('cm_raven.sentry_event_recorder')->getEventIdForException($exception);

Installation

The usual. Install it with composer require classmarkets/raven-bundle ~1.0.0 and add it to the kernel:, _(*5)

<?php

    public function registerBundles()
    {
        $bundles = array(
            // ...
            new \Classmarkets\RavenBundle\CMRavenBundle(),
        );
    }

Configuration

Quickstart

Assuming you are using Monolog's raven handler already, and have not changed the twig.exception_listener service, you already have something like this:, _(*6)

monolog:
    raven:
        type:  raven
        dsn: %sentry_dsn%
        level: error

Turn it into this:, _(*7)

monolog:
    raven:
        type:  raven
        dsn: "" # some versions of the monolog bundle require the dsn key to
                # be present (even if it is empty)
        client_id: raven
        level: error

cm_raven:
    client_id: raven

services:
    raven:
        class: Raven_Client
        arguments: [ %sentry_dsn% ]

If you already have monolog.raven.client_id configured, omit the extra service definition., _(*8)

The important thing is that monolog.raven.client_id equals cm_raven.client_id., _(*9)

If you are not using monolog, find the id for the service that provides the Raven_Client instance, and set cm_raven.client_id to that id., _(*10)

How it works

There are two parts to this bundle. Remembering event ids and making them available to error pages., _(*11)

The first part is easy. All we have to do is decorate a Raven_Client service with an event id recorder., _(*12)

The second part is tricky because the original exception doesn't make it into the template engine. Instead, it gets converted into a FlattenException. This FlattenException is unknown to our event recorder (because it only saw the original exception)., _(*13)

The FlattenException gets created by some protected method in the twig.exception_listener service. To solve our problem, we replace that service to associate the FlattenException with the same event id as the original exception., _(*14)

If your application already has a custom twig.exception_listener service, disable our implementation and call @cm_raven.sentry_event_recorder::addExceptionAlias($originalException, $flattenException) yourself (see ExceptionListener.php)., _(*15)

To disable the exception listener configure, _(*16)

cm_raven:
    enable_exception_listener: false