Monolog 优化及打造 ELK 友好的日志格式

Monolog 是目前最流行的php日志库，许多流行的php框架都用Monolog作为默认的日志库，例如symfony、laravel。

默认情况下，symfony、laravel在打印日志时都是来一条日志就打印一行到日志文件，这样就没有办法按照请求将日志聚合起来，更麻烦的是，多个并发的请求打印的日志是交叉的，这给本地调试、线上排查bug带来了许多麻烦。另外一个附带的问题是每写一行日志都得打开日志文件、写入日志、关闭日志文件，会产生大量的磁盘IO（即使是使用Monolog自带的BufferHandler将当前请求产生的所有日志缓冲到内存，等到请求结束再统一写入日志文件，也是每一条日志都得打开、写入、关闭日志文件）。

我希望的结果是：

• 一次请求所产生的日志需要一次打开、写入、关闭日志文件。
• 一次请求所产生的日志是紧密相连的，不会因为高并发而产生日志交叉的情况。
• 能够通过Logstash的multiline来聚合一次请求所产生的所有日志。
• 一些访问数据（如访问时间、访问者IP、访问的Url、该请求的执行时间等）能够被Logstash直接解析成字段，并能够在Kibana中查询、筛选。

最终代码如下：

1namespace App\Extensions\Log;
2
3use Carbon\Carbon;
4use Monolog\Handler\StreamHandler;
5use Monolog\Logger;
6
7class AggregateFileHandler extends StreamHandler
8{
9    public function handleBatch(array $records)
10    {
11        $dur     = number_format(microtime(true) - LARAVEL_START, 3);
12        $request = request();
13        $format  = 'Y-m-d H:i:s.u';
14        // 这一行是我们这个处理器自己加上的日志，记录请求时间、响应时间、访客IP，请求方法、请求Url
15        $log     = sprintf(
16            "[%s][%s]%s %s %s\n",
17            Carbon::createFromFormat('U.u', sprintf('%.6F', LARAVEL_START), config('app.timezone'))->format($format),
18            $dur,
19            $request->getClientIp(),
20            $request->getMethod(),
21            $request->getRequestUri()
22        );
23        // 然后将内存中的日志追加到$log这个变量里
24        foreach ($records as $record) {
25            if (!$this->isHandling($record)) {
26                continue;
27            }
28            $record = $this->processRecord($record);
29            $log .= $this->getFormatter()->format($record);
30        }
31        // 调用日志写入方法
32        $this->write(['formatted' => $log]);
33    }
34}

需要BufferHandler来配合使用：

1$handler = new AggregateFileHandler($path_to_log_file);
2$handler->setFormatter(
3    new LineFormatter("[%datetime%]%level_name% %message% %context% %extra%\n", 'i:s', true, true)
4);
5$monolog->pushHandler(new BufferHandler($handler));

AggregateRotatingFileHandler类只实现了一个handleBatch方法，BufferHandler会在请求结束时去调用handleBatch方法，因为我们不考虑单独使用这个处理器的情况，所以就没有去重写handler方法（实际上重写了也没法满足我们的需求）。

Logstash的配置如下：

1input {
2    file {
3        type => 'monolog'
4        path => "/home/vagrant/website/logs/app.log"
5    }
6}
7filter {
8    if [type] == 'monolog' {
9        multiline {
10            pattern => "\[[\d\-\: ]+?\]\[[\d\.]+?\]\d+\.\d+\.\d+\.\d+ \S+ \S+"
11            negate => true
12            what => "previous"
13        }
14        grok {
15            match => ["message", "\[%{TIMESTAMP_ISO8601:time}\]\[%{NUMBER:duration}\]%{IP:ip} %{WORD:method} %{DATA:url}\n%{GREEDYDATA:data}"]
16        }
17    }
18}

贴一个从ElasticSearch中查出的日志

1{
2  "_index" : "monolog",
3  "_type" : "monolog",
4  "_id" : "AVkgdHh4eDK8-gwc8OTf",
5  "_score" : 1.0,
6  "_source" : {
7    "message" : "[2016-12-21 08:16:27.373000][2.421]127.0.0.1 GET / \n[16:29]INFO Test Log 1\n[16:29]INFO Test Log 2",
8    "@version" : "1",
9    "@timestamp" : "2016-12-21T08:16:55.485Z",
10    "path" : "/home/vagrant/online/website/logs/monolog.log",
11    "host" : "0.0.0.0",
12    "type" : "monolog",
13    "tags" : [ "multiline" ],
14    "time" : "2016-12-21 08:16:27.373000",
15    "duration" : "2.421",
16    "ip" : "127.0.0.1",
17    "method" : "GET",
18    "url" : "/",
19    "data" : "[16:29]INFO Test Log 1\n[16:29]INFO Test Log 2"
20  }
21}