PHP日志配置太复杂？eonx-com/easy-logging助你轻松管理Monolog

Composer在线学习地址：学习地址

实际问题与痛点：复杂的 Monolog 日志配置

在日常的 php 项目开发中，日志记录是不可或缺的一环。我们通常会选择功能强大且灵活的 monolog 作为日志库。然而，随着项目规模的扩大和业务逻辑的复杂化，monolog 的配置也逐渐成为一个让人头疼的问题。

想象一下这样的场景：

1. 多渠道日志需求： 你可能需要为不同的模块或功能（如 Web 请求、API 调用、队列任务、控制台命令）设置独立的日志渠道（channels）。每个渠道可能需要不同的日志级别、不同的输出目标（文件、数据库、Slack、Sentry等）。
2. 复杂的处理器链： 为了让日志信息更丰富、更易于调试，你可能需要添加各种处理器（Processors），比如

   PsrLogMessageProcessor

   处理占位符、

   UidProcessor

   添加唯一ID、

   WebProcessor

   记录请求信息，甚至自定义处理器来添加业务上下文。
3. Handler 和 Processor 的顺序控制： Monolog 中 Handler 和 Processor 的执行顺序至关重要。错误的顺序可能导致日志信息不完整或处理逻辑出错。手动管理这些顺序，尤其是在有多个 Handler 和 Processor 时，非常容易出错。
4. 配置的重复与分散： 如果不加以规范，你可能会在项目的各个角落重复编写 Monolog 的配置代码，导致配置分散、难以维护，一旦需要修改某个 Handler 的配置，就可能需要改动多个文件。
5. 框架集成与依赖注入： 在 Laravel 或 Symfony 等框架中，如何优雅地将配置好的 Logger 实例注入到各个服务中，也是一个需要考虑的问题。

这些痛点使得日志配置从一个辅助功能变成了开发过程中的一个负担，不仅耗费时间，还增加了潜在的错误风险。

发现解决方案：eonx-com/easy-logging

正当我为这些繁琐的 Monolog 配置而烦恼，寻求一种更优雅、更集中的管理方式时，我偶然发现了

eonx-com/easy-logging

eonx-com/easy-logging

立即学习“PHP免费学习笔记（深入）”；

Composer 安装：简单快捷

使用 Composer 安装

eonx-com/easy-logging

composer require eonx-com/easy-logging

安装完成后，你就可以在项目中使用它提供的强大功能了。

核心理念与优势

eonx-com/easy-logging

1. 集中式配置： 它允许你通过 PHP 代码集中定义所有日志渠道的 Handlers 和 Processors，告别分散的配置。
2. 可复用性： 通过

   HandlerConfigProviderInterface

   和

   ProcessorConfigProviderInterface

   等接口，你可以创建可复用的配置提供者，将常用的 Handler 或 Processor 配置封装起来，方便在不同渠道或项目中复用。
3. 精确的顺序控制： 所有的配置提供者都支持设置优先级（

   priority

   ），这让你能够精确控制 Handlers 和 Processors 的添加顺序，确保日志处理流程符合预期。
4. 自动发现机制： 在支持的框架中，它能自动发现你定义的 Handler 和 Processor 配置提供者，进一步简化配置过程。
5. 优秀的框架集成： 它与 Laravel 和 Symfony 等主流 PHP 框架无缝集成，默认将配置好的 Logger 注册到服务容器中，通过依赖注入即可轻松使用。

实战演练：轻松配置你的 Logger

接下来，我们通过一些代码示例，看看

eonx-com/easy-logging

1. 创建 Logger 实例

首先，你需要一个

LoggerFactoryInterface

LoggerFactory

SCNet智能助手

SCNet超算互联网平台AI智能助手

下载

use EonX\EasyLogging\Factory\LoggerFactory;
use Psr\Log\LoggerInterface;

// 假设我们已经通过某种方式（例如DI容器）获取了 LoggerFactory实例
/** @var \EonX\EasyLogging\Factory\LoggerFactoryInterface $loggerFactory */
$loggerFactory = new LoggerFactory(); // 在实际应用中，通常通过DI获取

// 创建默认渠道的 Logger
$defaultLogger = $loggerFactory->create();
$defaultLogger->info('这是一条默认日志');

// 创建特定渠道的 Logger
$consoleLogger = $loggerFactory->create('console');
$consoleLogger->debug('这是一条控制台调试日志', ['command' => 'my:command']);

2. 配置 Handlers (处理程序)

eonx-com/easy-logging

HandlerConfigProviderInterface

// src/Logger/StreamHandlerConfigProvider.php
namespace App\Logger;

use EonX\EasyLogging\Config\HandlerConfig;
use EonX\EasyLogging\Provider\HandlerConfigProviderInterface;
use Monolog\Handler\StreamHandler;

final class StreamHandlerConfigProvider implements HandlerConfigProviderInterface
{
    /**
     * @return iterable<\EonX\EasyLogging\Config\HandlerConfigInterface>
     */
    public function handlers(): iterable
    {
        // 为所有渠道添加一个将日志写入 php://stdout 的 StreamHandler
        yield new HandlerConfig(new StreamHandler('php://stdout'));

        // 也可以为特定渠道添加 Handler
        yield new HandlerConfig(
            new StreamHandler(__DIR__ . '/../../var/log/app.log'),
            ['app'], // 只应用于 'app' 渠道
            100 // 优先级，数字越大越晚执行
        );

        yield new HandlerConfig(
            new StreamHandler(__DIR__ . '/../../var/log/error.log', \Monolog\Logger::ERROR),
            null, // 适用于所有渠道
            200 // 优先级更高，确保错误日志先被处理
        );
    }
}

然后，你需要将这些提供者注册到

LoggerFactory

use EonX\EasyLogging\Factory\LoggerFactory;
use App\Logger\StreamHandlerConfigProvider;

$loggerFactory = new LoggerFactory();
$loggerFactory->setHandlerConfigProviders([
    new StreamHandlerConfigProvider(),
    // ... 其他 HandlerConfigProvider
]);

$logger = $loggerFactory->create('app');
$logger->info('这条日志会写入 stdout 和 app.log');
$logger->error('这条错误日志会写入 stdout, app.log 和 error.log');

3. 配置 Processors (处理器)

与 Handlers 类似，Processors 通过

ProcessorConfigProviderInterface

// src/Logger/TagProcessorConfigProvider.php
namespace App\Logger;

use EonX\EasyLogging\Config\ProcessorConfig;
use EonX\EasyLogging\Provider\ProcessorConfigProviderInterface;
use Monolog\Processor\TagProcessor;
use Monolog\Processor\UidProcessor;

final class TagProcessorConfigProvider implements ProcessorConfigProviderInterface
{
    /**
     * @return iterable<\EonX\EasyLogging\Config\ProcessorConfigInterface>
     */
    public function processors(): iterable
    {
        // 为所有渠道添加一个 UID 处理器
        yield new ProcessorConfig(new UidProcessor());

        // 为 'console' 渠道添加一个 Tag 处理器
        yield new ProcessorConfig(
            new TagProcessor(['cli', 'background']),
            ['console'],
            100 // 优先级
        );
    }
}

同样，注册到

LoggerFactory

use EonX\EasyLogging\Factory\LoggerFactory;
use App\Logger\TagProcessorConfigProvider;
use App\Logger\StreamHandlerConfigProvider; // 假设也注册了 Handler

$loggerFactory = new LoggerFactory();
$loggerFactory->setHandlerConfigProviders([new StreamHandlerConfigProvider()]);
$loggerFactory->setProcessorConfigProviders([
    new TagProcessorConfigProvider(),
    // ... 其他 ProcessorConfigProvider
]);

$consoleLogger = $loggerFactory->create('console');
$consoleLogger->info('这条控制台日志会带上 UID 和 cli/background 标签');

4. 高级 Logger 配置

Monolog 的

Logger

useMicrosecondTimestamps()

eonx-com/easy-logging

LoggerConfiguratorInterface

// src/Logger/UseMicrosecondsLoggerConfigurator.php
namespace App\Logger;

use EonX\EasyLogging\Config\AbstractLoggingConfig;
use EonX\EasyLogging\Configurator\LoggerConfiguratorInterface;
use Monolog\Logger;

final class UseMicrosecondsLoggerConfigurator extends AbstractLoggingConfig implements LoggerConfiguratorInterface
{
    public function configure(Logger $logger) : void
    {
        // 启用微秒时间戳
        $logger->useMicrosecondTimestamps(true);
    }
}

注册到

LoggerFactory

use EonX\EasyLogging\Factory\LoggerFactory;
use App\Logger\UseMicrosecondsLoggerConfigurator;

$loggerFactory = new LoggerFactory();
$loggerFactory->setLoggerConfigurators([
    new UseMicrosecondsLoggerConfigurator(),
    // ... 其他 LoggerConfigurator
]);

$logger = $loggerFactory->create();
$logger->info('这条日志的时间戳将包含微秒');

总结与应用效果

eonx-com/easy-logging

实际应用效果显著：

• 代码整洁度提升： 日志配置代码集中管理，告别了散落在各处的

  new Logger(...)

  和

  ->pushHandler(...)

  。
• 维护成本降低： 无论是修改某个 Handler 的参数，还是调整 Processor 的顺序，都只需在一个地方进行改动，大大降低了维护成本。
• 开发效率提高： 新增日志渠道或功能时，可以快速复用已有的 Handler/Processor 配置，无需从头开始。
• 团队协作更顺畅： 统一的配置模式使得团队成员之间更容易理解和遵循日志规范。
• 更强的灵活性： 通过优先级和渠道过滤，可以轻松实现精细化的日志控制，满足各种复杂的业务需求。

如果你也曾被 Monolog 的繁琐配置所困扰，强烈推荐你尝试

eonx-com/easy-logging