rsands2801/sentry-laravel

Laravel integration for Sentry (http://getsentry.com)

sentry-laravel

Laravel integration for Sentry., _(*1)

Laravel 5.x

Install the sentry/sentry-laravel package:, _(*2)

$ composer require sentry/sentry-laravel

Add the Sentry service provider and facade in config/app.php:, _(*3)

'providers' => array(
    // ...
    Sentry\SentryLaravel\SentryLaravelServiceProvider::class,
)

'aliases' => array(
    // ...
    'Sentry' => Sentry\SentryLaravel\SentryFacade::class,
)

Add Sentry reporting to app/Exceptions/Handler.php:, _(*4)

public function report(Exception $exception)
{
    if ($this->shouldReport($exception)) {
        app('sentry')->captureException($exception);
    }
    parent::report($exception);
}

Create the Sentry configuration file (config/sentry.php):, _(*5)

$ php artisan vendor:publish --provider="Sentry\SentryLaravel\SentryLaravelServiceProvider"

Add your DSN to .env:, _(*6)

SENTRY_DSN=https://public:secret@sentry.example.com/1

Laravel 4.x

Install the sentry/sentry-laravel package:, _(*7)

$ composer require sentry/sentry-laravel

Add the Sentry service provider and facade in config/app.php:, _(*8)

'providers' => array(
    // ...
    'Sentry\SentryLaravel\SentryLaravelServiceProvider',
)

'aliases' => array(
    // ...
    'Sentry' => 'Sentry\SentryLaravel\SentryFacade',
)

Create the Sentry configuration file (config/sentry.php):, _(*9)

$ php artisan config:publish sentry/sentry-laravel

Lumen 5.x

Install the sentry/sentry-laravel package:, _(*10)

$ composer require sentry/sentry-laravel

Register Sentry in bootstrap/app.php:, _(*11)

$app->register('Sentry\SentryLaravel\SentryLumenServiceProvider');

# Sentry must be registered before routes are included
require __DIR__ . '/../app/Http/routes.php';

Add Sentry reporting to app/Exceptions/Handler.php:, _(*12)

public function report(Exception $e)
{
    if ($this->shouldReport($e)) {
        app('sentry')->captureException($e);
    }
    parent::report($e);
}

Create the Sentry configuration file (config/sentry.php):, _(*13)

<?php

return array(
    'dsn' => '___DSN___',

    // capture release as git sha
    // 'release' => trim(exec('git log --pretty="%h" -n1 HEAD')),

    // Capture bindings on SQL queries
    'breadcrumbs.sql_bindings' => true,

    // Capture default user context
    'user_context' => true,
);

Adding Context

The mechanism to add context will vary depending on which version of Laravel you're using, but the general approach is the same. Find a good entry point to your application in which the context you want to add is available, ideally early in the process., _(*14)

In the following example, we'll use a middleware:, _(*15)

namespace App\Http\Middleware;

use Closure;

class SentryContext
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request $request
     * @param  \Closure                 $next
     *
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if (app()->bound('sentry')) {
            /** @var \Raven_Client $sentry */
            $sentry = app('sentry');

            // Add user context
            if (auth()->check()) {
                $sentry->user_context([...]);
            } else {
                $sentry->user_context(['id' => null]);
            }

            // Add tags context
            $sentry->tags_context([...]);
        }

        return $next($request);
    }
}

Contributing

First, make sure you can run the test suite. Install development dependencies :, _(*16)

$ composer install

You may now use phpunit :, _(*17)

$ vendor/bin/phpunit

Resources

• Bug Tracker
• Code
• Mailing List
• IRC (irc.freenode.net, #sentry)