如何更有效的记录和管理日志 · ThinkPHP官方博客

### 2018 年 10 月 25 日发布日志是一个应用必不可少的功能组件，在某种程度上来说甚至具有不可替代的作用，无论是调试模式还是部署模式。 ThinkPHP5的日志功能非常强大，足以满足大部分的应用场景。 ## 日志记录除了系统自动生成的日志外，如果你需要添加自己的应用日志，可以使用`trace`助手函数或者`Log`类记录日志。 ``` trace('日志信息', '日志类型'); // 或者使用 \think\facade\Log::record('日志信息', '日志类型'); // 实时写入日志 \think\facade ``` >[info] 日志记录对于命令行和WEB访问有一个明显的差别就是命令行的日志记录是实时写入日志文件的（原因是为了避免内存中的日志记录开销过大，`Swoole`和`Workerman`也属于命令行常驻运行），而WEB访问则在每次请求完成后统一写日志文件。按照`PSR-3`日志规范，日志的级别从低到高依次为： `debug`, `info`, `notice`, `warning`, `error`, `critical`, `alert`, `emergency`，ThinkPHP额外增加了一个`sql`日志级别仅用于记录`SQL`日志（并且仅当开启数据库调试模式有效）。当然，你仍然可以增加自己的额外日志类型。原则上，在开发调试阶段，我们不应该错过任何的错误信息，而在部署阶段，可以有选择的记录某些日志类型从而避免日志文件过大。调整日志配置文件的配置参数： ``` // 允许记录的日志类型 'level' => ['error', 'critical', 'alert', 'emergency'], ``` >[danger] 敏感信息应该尽量记录在`debug`日志类型中，系统在部署模式下，默认会自动忽略`debug`类型的日志（除非你明确允许记录`debug`类型日志），确保日志泄露后可能造成的安全性。 ## 日志管理日志文件最好有一个统一的管理策略，例如在项目中规范日志的大小、数量以及采用的日志记录类型。目前框架内置的日志记录类型包括文件类型和`Socket`类型，`Socket`类型主要用于远程调试，具体用法可以参考官方的快速入门教程的[API调试](https://www.kancloud.cn/thinkphp/thinkphp5_quickstart/478323)一章，这里不再叙述。我们主要以文件类型日志为例来讲述日志管理。日志管理策略主要包含如下配置参数，你可以根据你的实际需求进行配置。 ### 日志大小（`file_size`）默认的日志文件大小是2097152字节（2M），超过设置的日志大小，会自动生成日志备份文件。实际应用中建议适当调大一些，可以避免日志文件过多。 ### 日志数量（`max_files`）默认情况下，日志是永久保存（直到存储占满为止），为了避免日志文件过大（一个月下来几十个G都有），建议设置一个最大日志文件数量，例如保留最近`50`个日志文件，超过后会自动删除最早的一个日志文件。 ### 独立类型日志（`apart_level`）如果你需要，可以设置某些级别的日志信息单独文件记录，方便你直接查看相关类型的问题，例如： ``` // error和sql日志单独记录 'apart_level' => ['error', 'sql'], ``` 设置后，就会单独生成`error`和`sql`两个类型的日志文件，主日志文件中将不再包含这两个级别的日志信息。如果需要所有日志类型单独记录文件的话，可以直接设置`apart_level`为`true`。 ### 单一日志（`single`）默认情况下的日志是按照日期为目录，按天为文件生成的（例如`201809/03.log`这种）但如果希望仅生成单个文件（方便其它的工具或者服务读取以及分析日志）。 ``` 'single' => true, ``` 开启生成单个文件后，`file_size`、`apart_level`和`max_files`参数依然有效，超过文件大小限制后，系统会自动生成备份日志文件。所以，一般开启单一日志后，建议调大日志大小（例如10M）。 >[info] 如果需要和阿里云的日志服务对接，可以设置为单一日志，更加方便阿里云的日志文件读取。 ### JSON日志（`json`）为了方便日志的后期分析，你可以设置使用`JSON`格式记录日志，开启后每次记录的日志会统一编码成`JSON`格式（目前`5.0`最新版本也支持`JSON`格式日志了）。在日志配置文件中，添加 ``` 'json' => true, ``` 即可开启JSON格式记录，对于命令行的日志记录同样有效。 >[danger] JSON格式记录日志的时候，独立记录日志级别参数`apart_level`无效。 ## 告警通知如果你需要加上错误日志的告警通知，可以利用日志类提供的两个钩子。钩子|描述|参数 ---|---|--- log_level|不同类型的日志写入|[ 日志类型, 日志信息（数组）] log_write|write方法或者命令行日志写入|日志信息我们可以添加行为来进行日志的通知，下面是一个很简单的发送邮件通知的行为类。 ``` <?php namespace app\index\behavior; class SendMail { public function run($params) { // 发送邮件通知 list($type, $message) = $params; if ('error' == $type) { mail('admin@mail.com', '系统日志通知', implode(' ', $message)); } } } ``` 绑定行为 ``` \think\facade\Hook::add('log_level', 'app\index\behavior\SendMail'); ``` 这样就可以在发生错误日志的时候自动邮件通知管理员。 `5.0`版本没有`log_level`钩子，但你仍然可以用`response_end`钩子，然后在行为里面获取当前的日志信息来进行处理。 ``` <?php namespace app\index\behavior; use think\facade\Log; class SendMail2 { public function run($params) { // 发送邮件通知 $logs = Log::getLog('error'); mail('admin@mail.com', '系统日志通知', implode(' ', $logs)); } } ``` >[danger] 以上方法同样也适用于`5.1`版本。如果你的应用压力较大，也可以通过把日志告警通知加入队列，在行为中不做具体的通知，只是加入通知队列。如果你已经使用了阿里云的[日志服务](https://www.aliyun.com/product/sls/)，那么可以对接ThinkPHP的日志文件，最好是开启JSON日志格式，便于阿里云的分析和查询，那么可以直接使用阿里云的日志告警和通知服务，具体可以参考阿里云的产品服务文档。 ## 扩展驱动如果你觉得内置的日志驱动仍然不能满足你的日志调试或者通知需求，你还可以自己扩展日志驱动。扩展一个日志驱动很简单，只需要在应用类库中扩展不需要修改核心。下面是一个很简单的使用`SeasLog`记录日志的驱动。 ``` <?php namespace app\driver\log; use think\App; class SeasLog { protected $config = []; // 实例化并传入参数 public function __construct(App $app, $config = []) { $this->config = array_merge($this->config, $config); \SeasLog::setBasePath($this->config['path']); if ($this->config['logger']) { \SeasLog::setLogger($this->config['logger']); } } /** * 日志写入接口 * @access public * @param array $log 日志信息 * @param bool $append 是否追加请求信息 * @return bool */ public function save(array $log = [], $append = false) { foreach ($log as $type => $val) { \SeasLog::log($type, implode("\n\r", $val)); } return \SeasLog::flushBuffer(); } ``` 更详细的实现可以参考`think-seaslog`扩展。最后，你只需要在`log.php`配置文件中设置`type`参数为 ``` 'type' => 'app\driver\log\SeasLog', ```