异常与日志处理

框架中提供基础错误处理，可以集中式处理各种异常。日志默认存储路径在 runtime/logs 中，可以通过业务需求，将日志集中发送到一个日志服务器中.

异常响应

根据配置, 框架中的异常会通过 json 的形式返回到客户端, 并记录到日志.

应用基础配置中异常处理配置示例:

  1. <?php
  3. return [
  4.     // some code
  5.     'exception' => [
  6.         'response' => function (Exception $e) {
  7.             return [
  8.                 'msg' => $e->getMessage(),
  9.                 'code' => $e->getCode(),
  10.             ];
  11.         },
  12.         'log' => function (Exception $e) {
  13.             return [
  14.                 'msg' => $e->getMessage(),
  15.                 'code' => $e->getCode(),
  16.                 'file' => $e->getFile(),
  17.                 'line' => $e->getLine(),
  18.                 'trace' => explode("\n", $e->getTraceAsString()),
  19.             ];
  20.         }
  21.     ],
  22.     // some code
  23. ];

当应用程序放生异常的时候，会根据 exception.response 配置的选项响应给客户端，并且会将异常日志按照 exception.log 配置项记录到日志文件，默认在: runtime/logs 中存储。

本地文件记录

日志服务依赖于 monolog，当应用程序发生异常时，程序会将异常信息记录在日志中。

配置: 

  1. <?php
  2. return [
  3.     'log' => [
  4.         [\Monolog\Handler\StreamHandler::class, 'error.log', \Monolog\Logger::ERROR]
  5.     ],
  6. ];

数组接受 4 个参数，分别解析成: handler, log file, level, formatter

socket 远端存储

当我们应用分布过多的时候，就需要考虑如何将日志集中管理起来，方便排查，分析。如果利用 Swoole 即将是一件容易实现的事情。启动我们的日志服务器，然后将每个应用日志都投递到日志服务器中。

应用中仅需要提交数据，数据处理就可以在日志服务器中完成。monolog 中可以使用 monolog-reader 进行解析。

  1. <?php
  2. return [
  3.     'log' => [
  4.         [new \Monolog\Handler\SocketHandler('schema://host:port'), 'error.log', \Monolog\Logger::ERROR]
  5.     ],
  6. ];

服务器接收提交信息后，对日志进行解析，批量入库，然后对应做响应的处理即可。

LogStash 日志格式

档如果我们日志分析系统使用 ELK 进行处理的时候，可以使用 \FastD\Logger\Formatter\StashFormatter 日志格式进行存储。

修改配置:

  1. <?php
  3. return [
  4.     // some code
  5.     'log' => [
  6.         [
  7.             \Monolog\Handler\StreamHandler::class,
  8.             'info.log',
  9.             \FastD\Logger\Logger::INFO,
  10.             \FastD\Logger\Formatter\StashFormatter::class,
  11.         ],
  12.     ],
  13.     // some code
  14. ];

然后启动 logstash agent，采集日志，即完成配置。

完整教程: FastD 最佳实践五: 构建ELK日志分析系统

下一节: 单元测试