Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neeckeloo/monolog-module
Monolog integration into Laminas
https://github.com/neeckeloo/monolog-module
lamina logging monolog
Last synced: 2 months ago
JSON representation
Monolog integration into Laminas
- Host: GitHub
- URL: https://github.com/neeckeloo/monolog-module
- Owner: neeckeloo
- License: mit
- Created: 2014-11-14T08:46:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T10:59:04.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T21:37:15.328Z (3 months ago)
- Topics: lamina, logging, monolog
- Language: PHP
- Homepage:
- Size: 66.4 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Monolog module for Laminas
=================================
Module to integrate Monolog with Laminas projects.
[](http://travis-ci.org/neeckeloo/monolog-module)
[](https://packagist.org/packages/neeckeloo/monolog-module)
[](https://packagist.org/packages/neeckeloo/monolog-module)
[](https://coveralls.io/r/neeckeloo/MonologModule)
## Requirements
* PHP ^8.0
* [monolog/monolog ^2.0 || ^3.0](http://www.github.com/Seldaek/monolog)
* [laminas/laminas-servicemanager ^3.3.2](https://github.com/laminas/laminas-servicemanager)
## Installation
MonologModule must be installed through Composer. For Composer documentation, please refer to [getcomposer.org](http://getcomposer.org).
You can install the module from command line:
```sh
$ composer require neeckeloo/monolog-module
```
Enable the module by adding `MonologModule` key in your `application.config.php` file.
## Usage
### Configuring a logger
This is the configuration of a logger that can be retrieved with key ```Log\App``` in the service manager. A channel name ```default``` is also defined to identify to which part of the application a record is related.
```php
return [
'monolog' => [
'loggers' => [
'Log\App' => [
'name' => 'default',
],
],
],
];
```
### Adding a handler
The logger itself does not know how to handle a record. It delegates it to some handlers. The code above registers two handlers in the stack to allow handling records in two different ways.
```php
return [
'monolog' => [
'loggers' => [
'Log\App' => [
'name' => 'default',
'handlers' => [
'stream' => [
'name' => StreamHandler::class,
'options' => [
'path' => 'data/log/application.log',
'level' => Logger::DEBUG,
],
],
'fire_php' => [
'name' => FirePHPHandler::class,
],
],
],
],
],
];
```
### Using processors
If you want to add extra information (tags, user IP, ...) to the records before they are handled, you should add some processors. The code above adds two processors that add an unique identifier and the current request URI, request method and client IP to a log record.
```php
return [
'monolog' => [
'loggers' => [
'Log\App' => [
'name' => 'default',
'handlers' => [
'default' => [
'name' => StreamHandler::class,
'options' => [
'path' => 'data/log/application.log',
'level' => Logger::DEBUG,
],
],
],
'processors' => [
UidProcessor::class,
WebProcessor::class,
],
],
],
],
];
```
You can also add processors to a specific handler.
```php
return [
'monolog' => [
'loggers' => [
'Log\App' => [
'name' => 'default',
'handlers' => [
'default' => [
'name' => StreamHandler::class,
'options' => [
'path' => 'data/log/application.log',
'level' => Logger::DEBUG,
],
'processors' => [
UidProcessor::class,
WebProcessor::class,
],
],
],
],
],
],
];
```
### Retrieving a logger
Once the configuration is complete, you can retrieve an instance of the logger as below:
```php
$logger = $serviceManager->get('Log\App');
$logger->debug('debug message');
```
## Testing
``` bash
$ vendor/bin/phpunit
```
## Credits
- [Nicolas Eeckeloo](https://github.com/neeckeloo)
- [All Contributors](https://github.com/RiskioFr/monolog-module/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/RiskioFr/monolog-module/blob/master/LICENSE) for more information.