macbre / monolog-utils
为 Monolog 提供额外的格式化和处理器
3.1.0
2024-09-09 21:21 UTC
Requires
- php: ^8.1
- monolog/monolog: ^3.3
Requires (Dev)
- phpunit/phpunit: ^10.0
This package is auto-updated.
Last update: 2024-09-09 21:22:22 UTC
README
为 Monolog 3.x 提供额外的格式化和处理器。此包需要 PHP 8.1+。
ExceptionProcessor
允许您将 Exception 实例作为 $context 的一部分传递 - 它将被自动展开以记录异常类、消息、代码和跟踪
try { // do something } catch (NastyException $ex) { $logger->error('Something bad happended', [ 'exception' => $ex ]); }
exception 字段将被展开为类似以下内容
{
"context": {
"exception": {
"class": "NastyException",
"message": "Things went wrong",
"code": 42,
"trace": [
"/home/macbre/app/Foo.class.php:979",
"/home/macbre/app/App.class.php:29",
"/home/macbre/app/index.php:18"
]
}
}
}
RequestIdProcessor
自动生成一个唯一的请求 ID,该 ID 作为 $extra 中的 request_id 字段与每个消息日志一起发送。
JsonFormatter
适用于 elastic / Kibana 的 JSON 日志格式化程序。
示例条目
$logger->error('Foo Bar', [ 'size' => 42 ]);
{
"@timestamp": "2023-04-18T08:25:23.123456+00:00",
"message": "Foo Bar",
"context": {
"size": 42
},
"extra": {
"request_id": "566c04c2f22693.59900054"
},
"severity": "error",
"channel": "my.app",
"source_host": "my.server.net"
}
示例
$logger = new Monolog\Logger('my.app'); $logger->pushProcessor(new Macbre\Logger\Processors\ExceptionProcessor()); $logger->pushProcessor(new Macbre\Logger\Processors\RequestIdProcessor()); // Syslog and JSON formatter for elastic / Kibana $syslog = new Monolog\Handler\SyslogUdpHandler('127.0.0.1', 514, LOG_USER, Monolog\Logger::INFO); $syslog->setFormatter(new Macbre\Logger\Formatters\JsonFormatter()); $logger->pushHandler($syslog); // and now let's use the logger... $logger->error('Foo Bar', [ 'exception' => new Exception('An error', 123), 'size' => 42 ]);