Yii Logging Library
The logger sends passes messages to multiple targets. Each target may filter messages by their severity levels and categories and then export them to some medium such as file, email or syslog.
- PHP 8.0 or higher.
The package could be installed with composer:
composer require yiisoft/log --prefer-dist
Creating a logger:
/** * List of class instances that extend the \Yiisoft\Log\Target abstract class. * * @var \Yiisoft\Log\Target $targets */ $logger = new \Yiisoft\Log\Logger($targets);
$logger->emergency('Emergency message', ['key' => 'value']); $logger->alert('Alert message', ['key' => 'value']); $logger->critical('Critical message', ['key' => 'value']); $logger->warning('Warning message', ['key' => 'value']); $logger->notice('Notice message', ['key' => 'value']); $logger->info('Info message', ['key' => 'value']); $logger->debug('Debug message', ['key' => 'value']);
Log messages are collected and stored in memory. To limit memory consumption, the logger will flush
the recorded messages to the log targets each time a certain number of log messages accumulate.
You can customize this number by calling the
$logger->setFlushInterval(100); // default is 1000
Each log target also collects and stores messages in memory.
Message exporting in a target follows the same principle as in the logger.
To change the number of stored messages, call the
$target->setExportInterval(100); // default is 1000
Note: All message flushing and exporting also occurs when the application ends.
This package contains two targets:
Yiisoft\Log\PsrTarget- passes log messages to another PSR-3 compatible logger.
Yiisoft\Log\StreamTarget- writes log messages to the specified output stream.
Extra logging targets are implemented as separate packages:
See Yii guide to logging for more info.
The package is tested with PHPUnit. To run tests:
The code is statically analyzed with Psalm. To run static analysis:
The Yii Logging Library is free software. It is released under the terms of the BSD License.
LICENSE for more information.
Maintained by Yii Software.