Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/macbre/monolog-utils
Addiitonal formatters and processors for Monolog
https://github.com/macbre/monolog-utils
logging monolog-handler monolog-processor php8
Last synced: 14 days ago
JSON representation
Addiitonal formatters and processors for Monolog
- Host: GitHub
- URL: https://github.com/macbre/monolog-utils
- Owner: macbre
- License: mit
- Created: 2015-11-24T21:01:00.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T10:17:37.000Z (8 months ago)
- Last Synced: 2024-04-24T15:16:21.636Z (8 months ago)
- Topics: logging, monolog-handler, monolog-processor, php8
- Language: PHP
- Homepage: https://packagist.org/packages/macbre/monolog-utils
- Size: 81.1 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
monolog-utils
===============
[](https://packagist.org/packages/macbre/monolog-utils)
[](https://coveralls.io/github/macbre/monolog-utils?branch=master)
Additional formatters and processors for Monolog 3.x. This package requires PHP 8.1+.
## `ExceptionProcessor`
Allows you to pass an `Exception` instance as a part of `$context` - it will be automatically expanded to log exception class, message, code and a backtrace
```php
try {
// do something
}
catch (NastyException $ex) {
$logger->error('Something bad happended', [
'exception' => $ex
]);
}
```
`exception` field will be expanded to something similar to:
```json
{
"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`
Automatically generates a unique, per request ID that is sent with every message log as `request_id` field in `$extra`.
## `JsonFormatter`
JSON log formatter for elastic / Kibana.
An example entry:
```php
$logger->error('Foo Bar', [
'size' => 42
]);
```
```json
{
"@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"
}
```
# Example
```php
$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
]);
```