PHP 日志记录 (monolog)

在 PHP 开发过程中，日志记录是一个非常重要的环节。它可以帮助开发者追踪应用程序运行时的状态，定位问题，以及监控应用的性能。Monolog 是一个广泛使用的 PHP 日志库，它提供了丰富的功能和灵活的配置选项。

Monolog 的安装

Monolog 可以通过 Composer 来安装。首先确保你的项目已经安装了 Composer，然后执行以下命令：

composer require monolog/monolog

这将把 Monolog 添加到你的 composer.json 文件中，并下载相关的依赖包。

创建 Logger 实例

Monolog 提供了一个简单的接口来创建和配置日志记录器。下面是一个创建基本 Logger 实例的例子：

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// 创建一个新的 Logger 实例
$logger = new Logger('my_logger');

// 添加一个处理器，这里使用 StreamHandler 将日志写入文件
$logger->pushHandler(new StreamHandler(__DIR__ . '/app.log', Logger::DEBUG));

在这个例子中，我们创建了一个名为 my_logger 的 Logger 实例，并添加了一个 StreamHandler 来将日志信息写入当前目录下的 app.log 文件。Logger::DEBUG 指定了日志级别为 DEBUG 及以上级别的日志都会被记录。

日志级别

Monolog 定义了几种不同的日志级别，这些级别从低到高依次是：

• DEBUG
• INFO
• NOTICE
• WARNING
• ERROR
• CRITICAL
• ALERT
• EMERGENCY

每个日志级别都有其特定的用途，例如，ERROR 级别用于记录应用程序中的错误情况，而 DEBUG 则用于更详细的调试信息。

记录日志

创建并配置好 Logger 实例后，我们可以开始记录日志了。Monolog 提供了多种方法来记录不同级别的日志信息。

记录信息日志

$logger->info('这是条信息日志');

记录警告日志

$logger->warning('这是一个警告日志');

记录错误日志

$logger->error('这是一个错误日志');

使用上下文数据

Monolog 允许你在记录日志时添加额外的上下文信息，这有助于更好地理解日志内容。

$context = ['ip' => $_SERVER['REMOTE_ADDR'], 'user_id' => 1];
$logger->warning('登录失败', $context);

处理器和格式化器

Monolog 支持多种处理器和格式化器，可以让你根据需要定制日志记录行为。例如，除了将日志写入文件外，还可以将日志发送到电子邮件、系统日志等地方。

添加 EmailHandler

use Monolog\Handler\EmailHandler;

$emailHandler = new EmailHandler('your-email@example.com', 'Error Report', 'Your Application', true, null, Logger::ERROR);
$logger->pushHandler($emailHandler);

这个例子展示了如何添加一个 EmailHandler，当发生 ERROR 或更高级别的错误时，会通过电子邮件通知你。

自定义格式化器

Monolog 还允许你自定义日志的格式，比如改变日期格式或增加额外的信息字段。

use Monolog\Formatter\LineFormatter;

$formatter = new LineFormatter(null, null, false, true); // 不包含日期时间，不换行
$streamHandler->setFormatter($formatter);

通过这种方式，你可以完全控制日志输出的格式，使之更加符合你的需求。

总结

Monolog 是一个强大且灵活的日志记录工具，非常适合 PHP 应用程序。通过上述示例，你应该能够开始在自己的项目中使用 Monolog 来增强日志记录功能。希望你能利用 Monolog 的功能更好地管理和维护你的应用程序。