Error Handling

Introduction

When you start a new Laravel project, error and exception handling is already configured for you. The App\Exceptions\Handler class is where all exceptions thrown by your application are logged and then rendered to the user. We'll dive deeper into this class throughout this documentation.

Configuration

The debug option in your config/app.php configuration file determines how much information about an error is actually displayed to the user. By default, this option is set to respect the value of the APP_DEBUG environment variable, which is stored in your .env file.

During local development, you should set the APP_DEBUG environment variable to true. In your production environment, this value should always be false. If the value is set to true in production, you risk exposing sensitive configuration values to your application's end users.

The Exception Handler

Reporting Exceptions

All exceptions are handled by the App\Exceptions\Handler class. This class contains a register method where you may register custom exception reporting and rendering callbacks. We'll examine each of these concepts in detail. Exception reporting is used to log exceptions or send them to an external service like Flare, Bugsnag, or Sentry. By default, exceptions will be logged based on your logging configuration. However, you are free to log exceptions however you wish.

If you need to report different types of exceptions in different ways, you may use the reportable method to register a closure that should be executed when an exception of a given type needs to be reported. Laravel will determine what type of exception the closure reports by examining the type-hint of the closure:

 1use App\Exceptions\InvalidOrderException;
 2 
 3/**
 4 * Register the exception handling callbacks for the application.
 5 */
 6public function register(): void
 7{
 8    $this->reportable(function (InvalidOrderException $e) {
 9        // ...
10    });
11}
 1use App\Exceptions\InvalidOrderException;
 2 
 3/**
 4 * Register the exception handling callbacks for the application.
 5 */
 6public function register(): void
 7{
 8    $this->reportable(function (InvalidOrderException $e) {
 9        // ...
10    });
11}

When you register a custom exception reporting callback using the reportable method, Laravel will still log the exception using the default logging configuration for the application. If you wish to stop the propagation of the exception to the default logging stack, you may use the stop method when defining your reporting callback or return false from the callback:

1$this->reportable(function (InvalidOrderException $e) {
2    // ...
3})->stop();
4 
5$this->reportable(function (InvalidOrderException $e) {
6    return false;
7});
1$this->reportable(function (InvalidOrderException $e) {
2    // ...
3})->stop();
4 
5$this->reportable(function (InvalidOrderException $e) {
6    return false;
7});
lightbulb

To customize the exception reporting for a given exception, you may also utilize reportable exceptions.

Global Log Context

If available, Laravel automatically adds the current user's ID to every exception's log message as contextual data. You may define your own global contextual data by defining a context method on your application's App\Exceptions\Handler class. This information will be included in every exception's log message written by your application:

 1/**
 2 * Get the default context variables for logging.
 3 *
 4 * @return array<string, mixed>
 5 */
 6protected function context(): array
 7{
 8    return array_merge(parent::context(), [
 9        'foo' => 'bar',
10    ]);
11}
 1/**
 2 * Get the default context variables for logging.
 3 *
 4 * @return array<string, mixed>
 5 */
 6protected function context(): array
 7{
 8    return array_merge(parent::context(), [
 9        'foo' => 'bar',
10    ]);
11}

Exception Log Context

While adding context to every log message can be useful, sometimes a particular exception may have unique context that you would like to include in your logs. By defining a context method on one of your application's exceptions, you may specify any data relevant to that exception that should be added to the exception's log entry:

 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6 
 7class InvalidOrderException extends Exception
 8{
 9    // ...
10 
11    /**
12     * Get the exception's context information.
13     *
14     * @return array<string, mixed>
15     */
16    public function context(): array
17    {
18        return ['order_id' => $this->orderId];
19    }
20}
 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6 
 7class InvalidOrderException extends Exception
 8{
 9    // ...
10 
11    /**
12     * Get the exception's context information.
13     *
14     * @return array<string, mixed>
15     */
16    public function context(): array
17    {
18        return ['order_id' => $this->orderId];
19    }
20}

The report Helper

Sometimes you may need to report an exception but continue handling the current request. The report helper function allows you to quickly report an exception via the exception handler without rendering an error page to the user:

 1public function isValid(string $value): bool
 2{
 3    try {
 4        // Validate the value...
 5    } catch (Throwable $e) {
 6        report($e);
 7 
 8        return false;
 9    }
10}
 1public function isValid(string $value): bool
 2{
 3    try {
 4        // Validate the value...
 5    } catch (Throwable $e) {
 6        report($e);
 7 
 8        return false;
 9    }
10}

Deduplicating Reported Exceptions

If you are using the report function throughout your application, you may occasionally report the same exception multiple times, creating duplicate entries in your logs.

If you would like to ensure that a single instance of an exception is only ever reported once, you may set the $withoutDuplicates property to true within your application's App\Exceptions\Handler class:

 1namespace App\Exceptions;
 2 
 3use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 4 
 5class Handler extends ExceptionHandler
 6{
 7    /**
 8     * Indicates that an exception instance should only be reported once.
 9     *
10     * @var bool
11     */
12    protected $withoutDuplicates = true;
13 
14    // ...
15}
 1namespace App\Exceptions;
 2 
 3use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 4 
 5class Handler extends ExceptionHandler
 6{
 7    /**
 8     * Indicates that an exception instance should only be reported once.
 9     *
10     * @var bool
11     */
12    protected $withoutDuplicates = true;
13 
14    // ...
15}

Now, when the report helper is called with the same instance of an exception, only the first call will be reported:

 1$original = new RuntimeException('Whoops!');
 2 
 3report($original); // reported
 4 
 5try {
 6    throw $original;
 7} catch (Throwable $caught) {
 8    report($caught); // ignored
 9}
10 
11report($original); // ignored
12report($caught); // ignored
 1$original = new RuntimeException('Whoops!');
 2 
 3report($original); // reported
 4 
 5try {
 6    throw $original;
 7} catch (Throwable $caught) {
 8    report($caught); // ignored
 9}
10 
11report($original); // ignored
12report($caught); // ignored

Exception Log Levels

When messages are written to your application's logs, the messages are written at a specified log level, which indicates the severity or importance of the message being logged.

As noted above, even when you register a custom exception reporting callback using the reportable method, Laravel will still log the exception using the default logging configuration for the application; however, since the log level can sometimes influence the channels on which a message is logged, you may wish to configure the log level that certain exceptions are logged at.

To accomplish this, you may define a $levels property on your application's exception handler. This property should contain an array of exception types and their associated log levels:

 1use PDOException;
 2use Psr\Log\LogLevel;
 3 
 4/**
 5 * A list of exception types with their corresponding custom log levels.
 6 *
 7 * @var array<class-string<\Throwable>, \Psr\Log\LogLevel::*>
 8 */
 9protected $levels = [
10    PDOException::class => LogLevel::CRITICAL,
11];
 1use PDOException;
 2use Psr\Log\LogLevel;
 3 
 4/**
 5 * A list of exception types with their corresponding custom log levels.
 6 *
 7 * @var array<class-string<\Throwable>, \Psr\Log\LogLevel::*>
 8 */
 9protected $levels = [
10    PDOException::class => LogLevel::CRITICAL,
11];

Ignoring Exceptions by Type

When building your application, there will be some types of exceptions you never want to report. To ignore these exceptions, define a $dontReport property on your application's exception handler. Any classes that you add to this property will never be reported; however, they may still have custom rendering logic:

 1use App\Exceptions\InvalidOrderException;
 2 
 3/**
 4 * A list of the exception types that are not reported.
 5 *
 6 * @var array<int, class-string<\Throwable>>
 7 */
 8protected $dontReport = [
 9    InvalidOrderException::class,
10];
 1use App\Exceptions\InvalidOrderException;
 2 
 3/**
 4 * A list of the exception types that are not reported.
 5 *
 6 * @var array<int, class-string<\Throwable>>
 7 */
 8protected $dontReport = [
 9    InvalidOrderException::class,
10];

Internally, Laravel already ignores some types of errors for you, such as exceptions resulting from 404 HTTP errors or 419 HTTP responses generated by invalid CSRF tokens. If you would like to instruct Laravel to stop ignoring a given type of exception, you may invoke the stopIgnoring method within your exception handler's register method:

 1use Symfony\Component\HttpKernel\Exception\HttpException;
 2 
 3/**
 4 * Register the exception handling callbacks for the application.
 5 */
 6public function register(): void
 7{
 8    $this->stopIgnoring(HttpException::class);
 9 
10    // ...
11}
 1use Symfony\Component\HttpKernel\Exception\HttpException;
 2 
 3/**
 4 * Register the exception handling callbacks for the application.
 5 */
 6public function register(): void
 7{
 8    $this->stopIgnoring(HttpException::class);
 9 
10    // ...
11}

Rendering Exceptions

By default, the Laravel exception handler will convert exceptions into an HTTP response for you. However, you are free to register a custom rendering closure for exceptions of a given type. You may accomplish this by invoking the renderable method within your exception handler.

The closure passed to the renderable method should return an instance of Illuminate\Http\Response, which may be generated via the response helper. Laravel will determine what type of exception the closure renders by examining the type-hint of the closure:

 1use App\Exceptions\InvalidOrderException;
 2use Illuminate\Http\Request;
 3 
 4/**
 5 * Register the exception handling callbacks for the application.
 6 */
 7public function register(): void
 8{
 9    $this->renderable(function (InvalidOrderException $e, Request $request) {
10        return response()->view('errors.invalid-order', [], 500);
11    });
12}
 1use App\Exceptions\InvalidOrderException;
 2use Illuminate\Http\Request;
 3 
 4/**
 5 * Register the exception handling callbacks for the application.
 6 */
 7public function register(): void
 8{
 9    $this->renderable(function (InvalidOrderException $e, Request $request) {
10        return response()->view('errors.invalid-order', [], 500);
11    });
12}

You may also use the renderable method to override the rendering behavior for built-in Laravel or Symfony exceptions such as NotFoundHttpException. If the closure given to the renderable method does not return a value, Laravel's default exception rendering will be utilized:

 1use Illuminate\Http\Request;
 2use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 3 
 4/**
 5 * Register the exception handling callbacks for the application.
 6 */
 7public function register(): void
 8{
 9    $this->renderable(function (NotFoundHttpException $e, Request $request) {
10        if ($request->is('api/*')) {
11            return response()->json([
12                'message' => 'Record not found.'
13            ], 404);
14        }
15    });
16}
 1use Illuminate\Http\Request;
 2use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 3 
 4/**
 5 * Register the exception handling callbacks for the application.
 6 */
 7public function register(): void
 8{
 9    $this->renderable(function (NotFoundHttpException $e, Request $request) {
10        if ($request->is('api/*')) {
11            return response()->json([
12                'message' => 'Record not found.'
13            ], 404);
14        }
15    });
16}

Reportable and Renderable Exceptions

Instead of defining custom reporting and rendering behavior in your exception handler's register method, you may define report and render methods directly on your application's exceptions. When these methods exist, they will automatically be called by the framework:

 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6use Illuminate\Http\Request;
 7use Illuminate\Http\Response;
 8 
 9class InvalidOrderException extends Exception
10{
11    /**
12     * Report the exception.
13     */
14    public function report(): void
15    {
16        // ...
17    }
18 
19    /**
20     * Render the exception into an HTTP response.
21     */
22    public function render(Request $request): Response
23    {
24        return response(/* ... */);
25    }
26}
 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6use Illuminate\Http\Request;
 7use Illuminate\Http\Response;
 8 
 9class InvalidOrderException extends Exception
10{
11    /**
12     * Report the exception.
13     */
14    public function report(): void
15    {
16        // ...
17    }
18 
19    /**
20     * Render the exception into an HTTP response.
21     */
22    public function render(Request $request): Response
23    {
24        return response(/* ... */);
25    }
26}

If your exception extends an exception that is already renderable, such as a built-in Laravel or Symfony exception, you may return false from the exception's render method to render the exception's default HTTP response:

 1/**
 2 * Render the exception into an HTTP response.
 3 */
 4public function render(Request $request): Response|bool
 5{
 6    if (/** Determine if the exception needs custom rendering */) {
 7 
 8        return response(/* ... */);
 9    }
10 
11    return false;
12}
 1/**
 2 * Render the exception into an HTTP response.
 3 */
 4public function render(Request $request): Response|bool
 5{
 6    if (/** Determine if the exception needs custom rendering */) {
 7 
 8        return response(/* ... */);
 9    }
10 
11    return false;
12}

If your exception contains custom reporting logic that is only necessary when certain conditions are met, you may need to instruct Laravel to sometimes report the exception using the default exception handling configuration. To accomplish this, you may return false from the exception's report method:

 1/**
 2 * Report the exception.
 3 */
 4public function report(): bool
 5{
 6    if (/** Determine if the exception needs custom reporting */) {
 7 
 8        // ...
 9 
10        return true;
11    }
12 
13    return false;
14}
 1/**
 2 * Report the exception.
 3 */
 4public function report(): bool
 5{
 6    if (/** Determine if the exception needs custom reporting */) {
 7 
 8        // ...
 9 
10        return true;
11    }
12 
13    return false;
14}
lightbulb

You may type-hint any required dependencies of the report method and they will automatically be injected into the method by Laravel's service container.

Throttling Reported Exceptions

If your application reports a very large number of exceptions, you may want to throttle how many exceptions are actually logged or sent to your application's external error tracking service.

To take a random sample rate of exceptions, you can return a Lottery instance from your exception handler's throttle method. If your App\Exceptions\Handler class does not contain this method, you may simply add it to the class:

 1use Illuminate\Support\Lottery;
 2use Throwable;
 3 
 4/**
 5 * Throttle incoming exceptions.
 6 */
 7protected function throttle(Throwable $e): mixed
 8{
 9    return Lottery::odds(1, 1000);
10}
 1use Illuminate\Support\Lottery;
 2use Throwable;
 3 
 4/**
 5 * Throttle incoming exceptions.
 6 */
 7protected function throttle(Throwable $e): mixed
 8{
 9    return Lottery::odds(1, 1000);
10}

It is also possible to conditionally sample based on the exception type. If you would like to only sample instances of a specific exception class, you may return a Lottery instance only for that class:

 1use App\Exceptions\ApiMonitoringException;
 2use Illuminate\Support\Lottery;
 3use Throwable;
 4 
 5/**
 6 * Throttle incoming exceptions.
 7 */
 8protected function throttle(Throwable $e): mixed
 9{
10    if ($e instanceof ApiMonitoringException) {
11        return Lottery::odds(1, 1000);
12    }
13}
 1use App\Exceptions\ApiMonitoringException;
 2use Illuminate\Support\Lottery;
 3use Throwable;
 4 
 5/**
 6 * Throttle incoming exceptions.
 7 */
 8protected function throttle(Throwable $e): mixed
 9{
10    if ($e instanceof ApiMonitoringException) {
11        return Lottery::odds(1, 1000);
12    }
13}

You may also rate limit exceptions logged or sent to an external error tracking service by returning a Limit instance instead of a Lottery. This is useful if you want to protect against sudden bursts of exceptions flooding your logs, for example, when a third-party service used by your application is down:

 1use Illuminate\Broadcasting\BroadcastException;
 2use Illuminate\Cache\RateLimiting\Limit;
 3use Throwable;
 4 
 5/**
 6 * Throttle incoming exceptions.
 7 */
 8protected function throttle(Throwable $e): mixed
 9{
10    if ($e instanceof BroadcastException) {
11        return Limit::perMinute(300);
12    }
13}
 1use Illuminate\Broadcasting\BroadcastException;
 2use Illuminate\Cache\RateLimiting\Limit;
 3use Throwable;
 4 
 5/**
 6 * Throttle incoming exceptions.
 7 */
 8protected function throttle(Throwable $e): mixed
 9{
10    if ($e instanceof BroadcastException) {
11        return Limit::perMinute(300);
12    }
13}

By default, limits will use the exception's class as the rate limit key. You can customize this by specifying your own key using the by method on the Limit:

 1use Illuminate\Broadcasting\BroadcastException;
 2use Illuminate\Cache\RateLimiting\Limit;
 3use Throwable;
 4 
 5/**
 6 * Throttle incoming exceptions.
 7 */
 8protected function throttle(Throwable $e): mixed
 9{
10    if ($e instanceof BroadcastException) {
11        return Limit::perMinute(300)->by($e->getMessage());
12    }
13}
 1use Illuminate\Broadcasting\BroadcastException;
 2use Illuminate\Cache\RateLimiting\Limit;
 3use Throwable;
 4 
 5/**
 6 * Throttle incoming exceptions.
 7 */
 8protected function throttle(Throwable $e): mixed
 9{
10    if ($e instanceof BroadcastException) {
11        return Limit::perMinute(300)->by($e->getMessage());
12    }
13}

Of course, you may return a mixture of Lottery and Limit instances for different exceptions:

 1use App\Exceptions\ApiMonitoringException;
 2use Illuminate\Broadcasting\BroadcastException;
 3use Illuminate\Cache\RateLimiting\Limit;
 4use Illuminate\Support\Lottery;
 5use Throwable;
 6 
 7/**
 8 * Throttle incoming exceptions.
 9 */
10protected function throttle(Throwable $e): mixed
11{
12    return match (true) {
13        $e instanceof BroadcastException => Limit::perMinute(300),
14        $e instanceof ApiMonitoringException => Lottery::odds(1, 1000),
15        default => Limit::none(),
16    };
17}
 1use App\Exceptions\ApiMonitoringException;
 2use Illuminate\Broadcasting\BroadcastException;
 3use Illuminate\Cache\RateLimiting\Limit;
 4use Illuminate\Support\Lottery;
 5use Throwable;
 6 
 7/**
 8 * Throttle incoming exceptions.
 9 */
10protected function throttle(Throwable $e): mixed
11{
12    return match (true) {
13        $e instanceof BroadcastException => Limit::perMinute(300),
14        $e instanceof ApiMonitoringException => Lottery::odds(1, 1000),
15        default => Limit::none(),
16    };
17}

HTTP Exceptions

Some exceptions describe HTTP error codes from the server. For example, this may be a "page not found" error (404), an "unauthorized error" (401), or even a developer generated 500 error. In order to generate such a response from anywhere in your application, you may use the abort helper:

1abort(404);
1abort(404);

Custom HTTP Error Pages

Laravel makes it easy to display custom error pages for various HTTP status codes. For example, to customize the error page for 404 HTTP status codes, create a resources/views/errors/404.blade.php view template. This view will be rendered for all 404 errors generated by your application. The views within this directory should be named to match the HTTP status code they correspond to. The Symfony\Component\HttpKernel\Exception\HttpException instance raised by the abort function will be passed to the view as an $exception variable:

1<h2>{{ $exception->getMessage() }}</h2>
1<h2>{{ $exception->getMessage() }}</h2>

You may publish Laravel's default error page templates using the vendor:publish Artisan command. Once the templates have been published, you may customize them to your liking:

1php artisan vendor:publish --tag=laravel-errors
1php artisan vendor:publish --tag=laravel-errors

Fallback HTTP Error Pages

You may also define a "fallback" error page for a given series of HTTP status codes. This page will be rendered if there is not a corresponding page for the specific HTTP status code that occurred. To accomplish this, define a 4xx.blade.php template and a 5xx.blade.php template in your application's resources/views/errors directory.

Comments

No Comments Yet
Add Comment

“Laravel” is a Trademark of Taylor Otwell.
The source documentation is released under MIT license. See laravel/docs on GitHub for details.
The translated documentations are released under MIT license. See cornch/laravel-docs-l10n on GitHub for details.