nikolaposa / monolog-factory

🏭 Configuration-based Monolog logger factory.

Monolog Factory

Monolog Factory that allows configuration-based creation of Logger objects.

In addition to the generic factory, this package features one to be used with PSR-11 dependency injection containers.

Installation

The preferred method of installation is via Composer. Run the following command to install the latest version of a package and add it to your project's composer.json:

composer require nikolaposa/monolog-factory

Usage

Generic factory

use Monolog\Formatter\HtmlFormatter;
use Monolog\Handler\NativeMailerHandler;
use Monolog\Logger;
use Monolog\Processor\PsrLogMessageProcessor;
use MonologFactory\LoggerFactory;

$loggerFactory = new LoggerFactory();

$logger = $loggerFactory->create('my_logger', [
    'handlers' => [
        [
            'name' => NativeMailerHandler::class,
            'params' => [
                'to' => '[email protected]',
                'subject' => 'Test',
                'from' => '[email protected]',
                'level' => Logger::ALERT,
            ],
            'formatter' => [
                'name' => HtmlFormatter::class,
            ],
        ],
    ],
    'processors' => [
        [
            'name' => PsrLogMessageProcessor::class,
        ],
    ],
]);

DI container factory configuration

use Monolog\Formatter\HtmlFormatter;
use Monolog\Handler\BufferHandler;
use Monolog\Handler\NativeMailerHandler;
use Monolog\Logger;
use Monolog\Processor\PsrLogMessageProcessor;
use MonologFactory\DiContainerLoggerFactory;

return [
    'logger' => [
        'logger1' => [
            'name' => 'logger1',
            'handlers' => [
                [
                    'name' => NativeMailerHandler::class,
                    'params' => [
                        'to' => '[email protected]',
                        'subject' => 'Test',
                        'from' => '[email protected]',
                        'level' => Logger::ALERT,
                    ],
                    'formatter' => [
                        'name' => HtmlFormatter::class,
                    ],
                ],
            ],
            'processors' => [
                [
                    'name' => PsrLogMessageProcessor::class,
                ],
            ],
        ],
        'logger2' => [
            'name' => 'logger2',
            'handlers' => [
                [
                    'name' => BufferHandler::class,
                    'params' => [
                        'handler' => [
                            '__class__' => NativeMailerHandler::class,
                            'to' => '[email protected]',
                            'subject' => 'Test',
                            'from' => '[email protected]',
                        ],
                        'buffer_limit' => 5,
                    ],
                    'processors' => [
                        [
                            'name' => MemoryUsageProcessor::class,
                        ],
                    ],
                ],
            ],
            'processors' => [
                [
                    'name' => PsrLogMessageProcessor::class,
                ],
            ],
        ],
    ],
    'di' => [
        'factories' => [
            'Logger1' => new DiContainerLoggerFactory('logger1'),
            //... or more preferred/optimal way:
            'Logger2' => [DiContainerLoggerFactory::class, 'logger2'],
        ],
    ],
];

See more examples.

Credits

• Nikola Poša
• All Contributors

License

Released under MIT License - see the License File for details.

monolog-factory's Issues

Suggestion about PHP 5 compatibility

Hello

Thanks for this great packages, that is very interresting. I've just one regret, that there is no version compatible with PHP 5.

Perharps a version 1.x compatible PHP5, and get version 2.x compatible PHP 7.

What do you think about this ?

Update for monolog 2

Can you update the library to use monolog 2?

Question: BufferHandler config

How I can describe BufferHandler?

I try:

$loggerFactory = new LoggerFactory();

$logger = $loggerFactory->createLogger('logger', [
    'handlers' => [
        [
            'name' => BufferHandler::class,
            'options' => [
                'handler' => [
                    'name' => NativeMailerHandler::class,
                    'options' => [
                        'to' => '[email protected]',
                        'subject' => 'Test',
                        'from' => '[email protected]',
                        'level' => Logger::ALERT,
                        'formatter' => [
                            'name' => HtmlFormatter::class,
                        ],
                    ],
                ]
            ]
        ]
    ]
]);

composer require psr/container fails

Hey and thx for this lib. May u will bump version of psr/container to ^2.0. On try to install psr/container i get follow problem from composer

Problem 1
    - nikolaposa/monolog-factory[dev-master, 3.1.0] require psr/container ^1.0 -> found psr/container[1.0.0, 1.1.0, 1.1.1, 1.1.x-dev] but it conflicts with your root composer.json require (^2.0).
    - nikolaposa/monolog-factory 3.1.x-dev is an alias of nikolaposa/monolog-factory dev-master and thus requires it to be installed too.
    - Root composer.json requires nikolaposa/monolog-factory ^3.1 -> satisfiable by nikolaposa/monolog-factory[3.1.0, 3.1.x-dev (alias of dev-master)].

thx in advance

Cannot define configuration for GroupHandler

How can I describe config for GroupHandler?

PHP 8 support

Hey!

Do you plan to support PHP 8 on this library? I can try to contribute the change if so.

Question: How add a processor for handler

Monolog handler can push custom processor for a handler. Can I define processor for a handler (non all handlers) via this lib.

Example:

'monolog' => [
			'config' => [
                                  'processors' => [...], // global processors for all handlers
				'handlers' => [
					'kibana' => [ ... ],
					'stdout' => [
						'name' => StreamHandler::class,
						'options' => [
							'stream' => 'php://stdout',
						],
                                                  'processors' => [...], // I want add processors for current handler
					],