Integrations
Deprecation Warning
A new PHP SDK has superseded this deprecated version. Sentry preserves this documentation for customers using the old client. If you are using PHP 7.1 or later, we recommend using the updated PHP SDK for your projects.
Laravel is supported via a native package, sentry-laravel.
Install the sentry/sentry-laravel package:
composer require sentry/sentry-laravel
If you’re on Laravel 5.4 or earlier, you’ll need to add the following to your config/app.php (for Laravel 5.5+ these will be auto-discovered by Laravel):
'providers' => array(
// ...
Sentry\SentryLaravel\SentryLaravelServiceProvider::class,
)
'aliases' => array(
// ...
'Sentry' => Sentry\SentryLaravel\SentryFacade::class,
)
Add Sentry reporting to App/Exceptions/Handler.php:
public function report(Exception $exception)
{
if (app()->bound('sentry') && $this->shouldReport($exception)) {
app('sentry')->captureException($exception);
}
parent::report($exception);
}
Create the Sentry configuration file (config/sentry.php):
php artisan vendor:publish --provider="Sentry\SentryLaravel\SentryLaravelServiceProvider"
Add your DSN to .env:
SENTRY_LARAVEL_DSN=https://examplePublicKey@o0.ingest.sentry.io/0
Finally, if you wish to wire up User Feedback, you can do so by creating a custom error view in resources/views/errors/500.blade.php.
For Laravel 5 up to 5.4 you need to open up App/Exceptions/Handler.php and extend the render method to make sure the 500 error is rendered as a view correctly, in 5.5+ this step is not required anymore and you can skip ahead to the next one:
<?php
use Symfony\Component\HttpKernel\Exception\HttpException;
class Handler extends ExceptionHandler
{
public function report(Exception $exception)
{
if (app()->bound('sentry') && $this->shouldReport($exception)) {
app('sentry')->captureException($exception);
}
parent::report($exception);
}
public function render($request, Exception $exception)
{
// Convert all non-http exceptions to a proper 500 http exception
// if we don't do this exceptions are shown as a default template
// instead of our own view in resources/views/errors/500.blade.php
if ($this->shouldReport($exception) && !$this->isHttpException($exception) && !config('app.debug')) {
$exception = new HttpException(500, 'Whoops!');
}
return parent::render($request, $exception);
}
}
Next, create resources/views/errors/500.blade.php, and embed the feedback code:
<div class="content">
<div class="title">Something went wrong.</div>
@if(app()->bound('sentry') && !empty(Sentry::getLastEventID()))
<div class="subtitle">Error ID: {{ Sentry::getLastEventID() }}</div>
<!-- Sentry JS SDK 2.1.+ required -->
<script src="https://cdn.ravenjs.com/3.3.0/raven.min.js"></script>
<script>
Raven.showReportDialog({
eventId: "{{ Sentry::getLastEventID() }}",
// use the public DSN (don't include your secret!)
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
user: {
name: "Jane Doe",
email: "jane.doe@example.com",
},
});
</script>
@endif
</div>
That’s it!
Install the sentry/sentry-laravel package:
Laravel 4.x is supported until version 0.8.x.
composer require sentry/sentry-laravel
Add the Sentry service provider and facade in config/app.php:
'providers' => array(
// ...
'Sentry\SentryLaravel\SentryLaravelServiceProvider',
)
'aliases' => array(
// ...
'Sentry' => 'Sentry\SentryLaravel\SentryFacade',
)
Create the Sentry configuration file (config/sentry.php):
php artisan config:publish sentry/sentry-laravel
Add your DSN to config/sentry.php:
<?php
return array(
'dsn' => 'https://examplePublicKey@o0.ingest.sentry.io/0',
// ...
);
If you wish to wire up Sentry anywhere outside of the standard error handlers, or if you need to configure additional settings, you can access the Sentry instance through $app:
$app['sentry']->setRelease(Git::sha());
Install the sentry/sentry-laravel package:
composer require sentry/sentry-laravel
Register Sentry in bootstrap/app.php:
$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:
public function report(Exception $e)
{
if (app()->bound('sentry') && $this->shouldReport($e)) {
app('sentry')->captureException($e);
}
parent::report($e);
}
Create the Sentry configuration file (config/sentry.php):
<?php
return array(
'dsn' => 'https://examplePublicKey@o0.ingest.sentry.io/0',
// capture release as git sha
// 'release' => trim(exec('git log --pretty="%h" -n1 HEAD')),
);
You can test your configuration using the provided artisan command:
php artisan sentry:test
[sentry] Client configuration:
-> server: https://sentry.io/api/3235/store/
-> project: 3235
-> public_key: e9ebbd88548a441288393c457ec90441
-> secret_key: 399aaee02d454e2ca91351f29bdc3a07
[sentry] Generating test event
[sentry] Sending test event with ID: 5256614438cf4e0798dc9688e9545d94
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.
In the following example, we’ll use a middleware:
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);
}
}
The following settings are available for the client:
dsn
The DSN to authenticate with Sentry.
'dsn' => 'https://examplePublicKey@o0.ingest.sentry.io/0',
release
The version of your application (e.g. git SHA)
'release' => MyApp::getReleaseVersion(),
breadcrumbs.sql_bindings
Capture bindings on SQL queries.
Defaults to true.
'breadcrumbs.sql_bindings' => false,
user_context
Capture user_context automatically.
Defaults to true.
'user_context' => false,
Monolog supports Sentry out of the box, so you’ll just need to configure a handler:
$client = new Raven_Client('https://examplePublicKey@o0.ingest.sentry.io/0');
$handler = new Monolog\Handler\RavenHandler($client);
$handler->setFormatter(new Monolog\Formatter\LineFormatter("%message% %context% %extra%\n"));
$monolog->pushHandler($handler);
Capturing context can be done via a monolog processor:
$monolog->pushProcessor(function ($record) {
// record the current user
$user = Acme::getCurrentUser();
$record['context']['user'] = array(
'name' => $user->getName(),
'username' => $user->getUsername(),
'email' => $user->getEmail(),
);
// Add various tags
$record['context']['tags'] = array('key' => 'value');
// Add various generic context
$record['extra']['key'] = 'value';
return $record;
});
Sentry provides a breadcrumb handler to automatically send logs along as crumbs:
$client = new Raven_Client('https://examplePublicKey@o0.ingest.sentry.io/0');
$handler = new \Raven_Breadcrumbs_MonologHandler($client);
$monolog->pushHandler($handler);
Symfony is supported via the sentry-symfony package as a native bundle.
Install the sentry/sentry-symfony package:
composer require sentry/sentry-symfony:^2
Newer version
This documentation refers to the v2.x of the bundle. This version does not support the newest Unified API client.
You can upgrade to the newer version if you're on PHP 7.1+ and Symfony 3.4+.
Enable the bundle in app/AppKernel.php:
public function registerBundles()
{
$bundles = [
// ...
new Sentry\SentryBundle\SentryBundle(),
);
// ...
}
Add your DSN to app/config/config.yml:
sentry:
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0"
You can easily verify that Sentry is capturing errors in your Symfony application by creating a debug route that will throw an exception:
/**
* @Route("/debug-sentry")
*/
public function debug_sentry()
{
throw new Exception('My first Sentry error!');
}
Visiting this route will trigger an exception that will be captured by Sentry.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").