yiisoft/log

Yii Logging Library

2.0.0 2022-05-22 12:30 UTC

Requires

• php: ^8.0
• psr/log: ^2.0|^3.0
• yiisoft/var-dumper: ^1.0

Requires (Dev)

• ext-json: *
• phpunit/phpunit: ^9.5
• roave/infection-static-analysis-plugin: ^1.18
• spatie/phpunit-watcher: ^1.23
• vimeo/psalm: ^4.22

Suggests

• yiisoft/log-target-db: Allows writing log messages to the database
• yiisoft/log-target-email: Allows sending log messages by email
• yiisoft/log-target-file: Allows writing log messages to the files
• yiisoft/log-target-syslog: Allows writing log messages to the Syslog

Provides

• psr/log-implementation: 1.0.0

BSD-3-Clause

• log
• framework
• logger
• yii
• psr-3

README

Yii Logging Library

This package provides PSR-3 compatible logging library. It is used in Yii Framework but is usable separately.

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.

Requirements

• PHP 8.0 or higher.

Installation

The package could be installed with composer:

composer require yiisoft/log --prefer-dist

General usage

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);

Writing logs:

$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']);

Message Flushing and Exporting

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 \Yiisoft\Log\Logger::setFlushInterval() method:

$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 \Yiisoft\Log\Target::setExportInterval() method:

$target->setExportInterval(100); // default is 1000

Note: All message flushing and exporting also occurs when the application ends.

Logging targets

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:

• Database
• Email
• File
• Syslog

See Yii guide to logging for more info.

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii Logging Library is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates