sentry/sentry-laravel

Laravel integration for Sentry (https://sentry.io)

Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us Check out our open positions, _(*1)

Official Sentry SDK for Laravel

, _(*2)

This is the official Laravel SDK for Sentry., _(*3)

Getting Started

The installation steps below work on version 11.x of the Laravel framework., _(*4)

For older Laravel versions and Lumen see:, _(*5)

• Laravel 11.x
• Laravel 8.x & 9.x & 10.x
• Laravel 6.x & 7.x
• Laravel 5.x
• Laravel 4.x
• Lumen

Install

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

composer require sentry/sentry-laravel

Enable capturing unhandled exception to report to Sentry by making the following change to your bootstrap/app.php:, _(*7)

```php {filename:bootstrap/app.php} <?php, <sub>(*8)</sub>

use Illuminate\Foundation\Application; use Illuminate\Foundation\Configuration\Exceptions; use Illuminate\Foundation\Configuration\Middleware; use Sentry\Laravel\Integration;, <sub>(*9)</sub>

return Application::configure(basePath: dirname(DIR)) ->withRouting( web: DIR.'/../routes/web.php', commands: DIR.'/../routes/console.php', health: '/up', ) ->withMiddleware(function (Middleware $middleware) { // }) ->withExceptions(function (Exceptions $exceptions) { Integration::handles($exceptions); })->create();, <sub>(*10)</sub>

> Alternatively, you can configure Sentry as a [Laravel Log Channel](https://docs.sentry.io/platforms/php/guides/laravel/usage/#log-channels), allowing you to capture `info` and `debug` logs as well.

### Configure

Configure the Sentry DSN with this command:

```shell
php artisan sentry:publish --dsn=___PUBLIC_DSN___

It creates the config file (config/sentry.php) and adds the DSN to your .env file., <sub>(*11)</sub>

```shell {filename:.env} SENTRY_LARAVEL_DSN=PUBLIC_DSN, <sub>(*12)</sub>

### Usage

```php
use function Sentry\captureException;

try {
    $this->functionThatMayFail();
} catch (\Throwable $exception) {
    captureException($exception);
}

To learn more about how to use the SDK refer to our docs., <sub>(*13)</sub>

Laravel Version Compatibility

The Laravel and Lumen versions listed below are all currently supported:, <sub>(*14)</sub>

• Laravel >= 11.x.x on PHP >= 8.2 is supported starting from 4.3.0
• Laravel >= 10.x.x on PHP >= 8.1 is supported starting from 3.2.0
• Laravel >= 9.x.x on PHP >= 8.0 is supported starting from 2.11.0
• Laravel >= 8.x.x on PHP >= 7.3 is supported starting from 1.9.0
• Laravel >= 7.x.x on PHP >= 7.2 is supported starting from 1.7.0
• Laravel >= 6.x.x on PHP >= 7.2 is supported starting from 1.2.0

Please note that starting with version >= 2.0.0 we require PHP Version >= 7.2 because we are using our new PHP SDK underneath., <sub>(*15)</sub>

The Laravel versions listed below were supported in previous versions of the Sentry SDK for Laravel:, <sub>(*16)</sub>

• Laravel <= 4.2.x is supported until 0.8.x
• Laravel <= 5.7.x on PHP <= 7.0 is supported until 0.11.x
• Laravel >= 5.x.x on PHP >= 7.1 is supported until 2.14.x

Contributing to the SDK

Please refer to CONTRIBUTING.md., <sub>(*17)</sub>

Thanks to all the people who contributed so far!

, <sub>(*18)</sub>

Getting Help/Support

If you need help setting up or configuring the Laravel SDK (or anything else in the Sentry universe) please head over to the Sentry Community on Discord. There is a ton of great people in our Discord community ready to help you!, <sub>(*19)</sub>

Resources

License

Licensed under the MIT license, see LICENSE., <sub>(*20)</sub>