Monolog v3中自定义日志源信息的解决方案

概述

在使用Monolog日志库时，许多开发者会遇到需要自定义日志源信息(如source和host字段)的需求。特别是在Docker容器化环境中，默认获取的主机名和IP地址往往无法满足多服务器日志区分的要求。本文将详细介绍在Monolog v3中如何优雅地实现这一功能。

问题背景

在Monolog v2.7.0及更早版本中，开发者可以通过实现ProcessorInterface接口，直接修改日志记录的数组来添加自定义字段：

class SourceProcessor implements ProcessorInterface
{
    public function __invoke(array $record): array
    {
        $record['source'] = 'ops.' . $_ENV['ENVIRONMENT'];
        $record['host'] = 'ops.' . $_ENV['ENVIRONMENT'];
        return $record;
    }
}

然而在Monolog v3中，日志记录被封装为LogRecord对象，不再允许直接添加任意字段，这种直接修改数组的方式不再适用。

Monolog v3的解决方案

Monolog v3提供了更加结构化的日志记录处理方式。要添加自定义字段，推荐使用以下两种方法：

方法一：使用上下文(Context)和额外数据(Extra)

可以通过处理器(Processor)将数据添加到上下文中：

class SourceProcessor implements ProcessorInterface
{
    public function __invoke(LogRecord $record): LogRecord
    {
        $context = $record->context;
        $context['source'] = 'ops.' . $_ENV['ENVIRONMENT'];
        $context['host'] = 'ops.' . $_ENV['ENVIRONMENT'];
        
        return $record->with(context: $context);
    }
}

方法二：自定义格式化器(推荐)

更优雅的解决方案是创建自定义的JSON格式化器，直接控制最终的日志输出格式：

namespace App\Monolog\Formatter;

use Monolog\Formatter\FormatterInterface;
use Monolog\LogRecord;
use stdClass;

class JsonFormatter implements FormatterInterface
{
    public function format(LogRecord $record)
    {
        $output = new stdClass;
        $output->source = 'subdomainhere.' . $_ENV['ENVIRONMENT'];
        $output->host = 'subdomainhere.' . $_ENV['ENVIRONMENT'];
        $output->context = $record->context;
        $output->message = $record->message;
        $output->timestamp = date(DATE_ISO8601);

        return json_encode($output).PHP_EOL;
    }
 
    public function formatBatch(array $records)
    {
        foreach ($records as $key => $record) {
            $records[$key] = $this->format($record);
        }
        return $records;
    }
}

方案对比

方案	优点	缺点
上下文方式	保持Monolog原生结构	源信息会嵌套在context中
自定义格式化器	完全控制输出结构	需要实现完整格式化逻辑

最佳实践建议

1. 生产环境推荐：使用自定义格式化器方案，可以完全控制日志结构，便于日志收集系统解析。

2. 多环境处理：如示例所示，结合环境变量($_ENV['ENVIRONMENT'])可以轻松实现多环境区分。

3. 性能考虑：如果日志量很大，建议在格式化器中缓存不变的值(如环境名称)。

4. 字段标准化：建议团队统一日志字段命名规范，如使用小写字母和下划线分隔。

总结

Monolog v3通过更严格的对象封装提高了代码的健壮性。虽然不再允许随意添加字段，但通过上下文或自定义格式化器的方式，开发者仍然可以灵活地控制日志输出内容。自定义格式化器方案尤其适合需要将特定字段放在日志顶层的场景，是在容器化环境中区分日志源的理想解决方案。