Laravel 的错误和日志记录

简介

Laravel 默认自带错误和异常处理机制。应用程序触发的所有异常都被 App\Exceptions\Handler 类记录下来，然后渲染给用户。 我们将在后续文档中深入介绍此类。

Laravel 使用 Monolog 库为各种强大的日志处理程序提供支持。Laravel 配置了多种日志处理程序，方便你在单个日志文件、多个日志文件或将错误信息写入系统日志之间进行选择。

配置

错误的详细信息

config/app.php 配置文件的 debug 选项决定了是否向用户显示错误信息。默认情况下，此选项设置为获取存储在 .env 文件中的 APP_DEBUG 环境变量的值。

对于本地开发，应该将 APP_DEBUG 环境变量设置为 true 。而在生产环境中，此值应始终保持 false 。如果你在生产中将该值设置为 true ，则有可能会将敏感的配置信息暴露给应用程序的最终用户。

日志存储

Laravel 支持 single 、daily 、 syslog 和 errorlog 四种日志写入模式。通过修改 config/app.php 配置文件中的 log 选项来配置 Laravel 使用的存储机制。如果你希望每天产生日志都存放在不同的文件中，则应将 app 配置文件中的 log 值设置为 daily：

  1. 'log' => 'daily'

最大日志文件数

在使用 daily 日志模式时，Laravel 默认只保留五天份的日志文件。如果要调整保留文件的数量，就在 app 配置文件中添加一个 log_max_files 配置项：

  1. 'log_max_files' => 30

日志严重程度级别

使用 Monolog 时，日志消息可能具有不同程度的严重级别。默认情况下，Laravel 将存储所有级别的日志。你也可以在生产环境中通过将 log_level 选项添加到 app.php 配置文件中来配置应当记录的严重程度最低的日志级别。

配置之后，Laravel 就只会记录大于或等于指定严重级别的所有级别的错误。例如，默认的 log_level 被设置为 error，那么 Laravel 只会记录 error、critical、alert 和 emergency 级别的日志信息：

  1. 'log_level' => env('APP_LOG_LEVEL', 'error'),

{tip} Monolog 识别以下严重程度的级别，从低到高为: debug、 info、notice、 warning、error、critical、alert、emergency。

自定义 Monolog 配置

你可以使用 configureMonologUsing 方法来配置应用程序对 Monolog 的完全控制。在 $app 变量返回之前，在 bootstrap/app.php 文件中调用此方法：

  1. $app->configureMonologUsing(function ($monolog) {
  2.     $monolog->pushHandler(...);
  3. });
  5. return $app;

自定义渠道名称

默认情况下，Monolog 用与当前环境匹配的名称进行实例化，如 production 或 local。要更改此值，可将 log_channel 选项添加到 app.php 配置文件中：

  1. 'log_channel' => env('APP_LOG_CHANNEL', 'my-app-name'),

异常处理

Report 方法

所有异常都由 App\Exceptions\Handler 类处理。 这个类包含两个方法：report 和 render。report 方法用于记录异常或将其发送到外部服务，如 Bugsnag 或 Sentry。默认情况下，report 方法只是简单地将异常传递给记录异常的基类。你可以根据需要来记录异常。

例如，如果你需要以不同的方式报告不同类型的异常，你可以使用 PHP 的比较运算符 instanceof：

  1. /**
  2.  * 报告或记录一个异常
  3.  *
  4.  * 这是个给 Bugsnag 或 Sentry 发送异常的好地方
  5.  *
  6.  * @param  \Exception  $exception
  7.  * @return void
  8.  */
  9. public function report(Exception $exception)
  10. {
  11.     if ($exception instanceof CustomException) {
  12.         //
  13.     }
  15.     return parent::report($exception);
  16. }

辅助函数 report

某些时候你可能想要报告一个异常，但又想继续处理当前的请求。辅助函数 report 允许你使用异常处理程序的 report 方法快速报告一个异常而不抛出一个错误页面：

  1. public function isValid($value)
  2. {
  3.     try {
  4.         // 校验值...
  5.     } catch (Exception $e) {
  6.         report($e);
  8.         return false;
  9.     }
  10. }

按类型忽略异常

异常处理程序的 $dontReport 属性包含不会被记录的异常类型数组。例如，404错误导致的异常以及其他类型的错误不会写入日志文件。你可以根据需要向此数组添加其他异常类型：

  1. /**
  2.  * 不应报告的异常类型列表。
  3.  *
  4.  * @var array
  5.  */
  6. protected $dontReport = [
  7.     \Illuminate\Auth\AuthenticationException::class,
  8.     \Illuminate\Auth\Access\AuthorizationException::class,
  9.     \Symfony\Component\HttpKernel\Exception\HttpException::class,
  10.     \Illuminate\Database\Eloquent\ModelNotFoundException::class,
  11.     \Illuminate\Validation\ValidationException::class,
  12. ];

Render 方法

render 方法负责将给定的异常转换成发送给浏览器的 HTTP 响应。默认情况下，异常会传递为你生成响应的基类。你还可以根据需要检查异常类型或返回自定义的响应：

  1. /**
  2.  * 渲染异常到 HTTP 响应中.
  3.  *
  4.  * @param  \Illuminate\Http\Request  $request
  5.  * @param  \Exception  $exception
  6.  * @return \Illuminate\Http\Response
  7.  */
  8. public function render($request, Exception $exception)
  9. {
  10.     if ($exception instanceof CustomException) {
  11.         return response()->view('errors.custom', [], 500);
  12.     }
  14.     return parent::render($request, $exception);
  15. }

自定义异常的 report & render 方法

你并不一定要在异常处理程序中的 report 和 render 方法中处理不同类型的异常，可以直接在自定义的异常处理程序中定义 report 和 render 方法。如果这些方法存的在话，框架会自动调用他们：

  1. <?php
  3. namespace App\Exceptions;
  5. use Exception;
  7. class RenderException extends Exception
  8. {
  9.     /**
  10.      * 报告异常
  11.      *
  12.      * @return void
  13.      */
  14.     public function report()
  15.     {
  16.         //
  17.     }
  19.     /**
  20.      * 将异常渲染到 HTTP 响应中。
  21.      *
  22.      * @param  \Illuminate\Http\Request
  23.      * @return void
  24.      */
  25.     public function render($request)
  26.     {
  27.         return response(...);
  28.     }
  29. }

HTTP 异常

一些异常描述了来自服务器的 HTTP 错误代码。例如，可能是错误代码 404 的「找不到页面」、401 的「未授权错误」甚至可能是由开发者造成的 500。你可以使用辅助函数 abort 在应用程序中的任何地方生成这样的响应：

  1. abort(404);

辅助函数 abort 会创建一个由异常处理程序渲染的异常。此外，你还可以提供响应文本：

  1. abort(403, 'Unauthorized action.');

自定义 HTTP 错误页面

Laravel 可以轻松地显示各种 HTTP 状态代码的自定义错误页面。例如，如果你要自定义 404 HTTP 状态代码的错误页面，就创建一个 resources/views/errors/404.blade.php 。此文件将会用于渲染你应用中产生的所有 404 错误。此目录中的视图文件的命名应该与它们对应的 HTTP 状态代码匹配。由 abort 函数引发的 HttpException 实例将作为 $exception 变量传递给视图。

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

日志

Laravel 在强大的 Monolog 库上提供了一个简单的抽象层。默认情况下，Laravel 的日志文件的存储目录被配置为 storage/logs 。你可以使用 Log facade 将信息写入日志：

  1. <?php
  3. namespace App\Http\Controllers;
  5. use App\User;
  6. use Illuminate\Support\Facades\Log;
  7. use App\Http\Controllers\Controller;
  9. class UserController extends Controller
  10. {
  11.     /**
  12.      * 显示给定用户的配置。
  13.      *
  14.      * @param  int  $id
  15.      * @return Response
  16.      */
  17.     public function showProfile($id)
  18.     {
  19.         Log::info('Showing user profile for user: '.$id);
  21.         return view('user.profile', ['user' => User::findOrFail($id)]);
  22.     }
  23. }

该日志记录器提供 RFC 5424 中定义的八种日志级别：emergency、alert、critical、error、warning、notice、info 和 debug。

  1. Log::emergency($message);
  2. Log::alert($message);
  3. Log::critical($message);
  4. Log::error($message);
  5. Log::warning($message);
  6. Log::notice($message);
  7. Log::info($message);
  8. Log::debug($message);

上下文信息

上下文数据也可以用数组的形式传递给日志方法。此上下文数据将被格式化并与日志消息一起显示：

  1. Log::info('User failed to login.', ['id' => $user->id]);

访问底层的 Monolog 实例

Monolog 还提供了各种可用于记录的处理程序。如果需要，你可以访问 Laravel 使用的底层的 Monolog 实例：

  1. $monolog = Log::getMonolog();

译者署名

用户名 头像 职能 签名
@ChrisonWang Laravel 的错误和日志记录 - 图1 翻译 @王欣 at LinkedIn
@JokerLinly Laravel 的错误和日志记录 - 图2 Review Stay Hungry. Stay Foolish.

{note} 欢迎任何形式的转载，但请务必注明出处，尊重他人劳动共创开源社区。

转载请注明：本文档由 Laravel China 社区 laravel-china.org 组织翻译，详见 翻译召集帖。

文档永久地址： https://d.laravel-china.org