Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samdark/yii2-psr-log-target
Yii 2.0 log target that is able to write messages to PSR-3 compatible logger
https://github.com/samdark/yii2-psr-log-target
log logger logging psr-3 yii2 yii2-extension
Last synced: 6 days ago
JSON representation
Yii 2.0 log target that is able to write messages to PSR-3 compatible logger
- Host: GitHub
- URL: https://github.com/samdark/yii2-psr-log-target
- Owner: samdark
- License: bsd-3-clause
- Created: 2017-03-07T10:51:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T16:58:50.000Z (9 months ago)
- Last Synced: 2024-09-18T22:32:58.889Z (15 days ago)
- Topics: log, logger, logging, psr-3, yii2, yii2-extension
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 80
- Watchers: 9
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Yii 2 PSR Log Target
Allows you to process logs using any PSR-3 compatible logger such as [Monolog](https://github.com/Seldaek/monolog).
[](https://packagist.org/packages/samdark/yii2-psr-log-target)
[](https://packagist.org/packages/samdark/yii2-psr-log-target)
[](https://github.com/samdark/yii2-psr-log-target/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/samdark/yii2-psr-log-target)
[](https://scrutinizer-ci.com/g/samdark/yii2-psr-log-target/)
## Installation
```
composer require "samdark/yii2-psr-log-target"
```
## Usage
In order to use `PsrTarget` you should configure your `log` application component like the following:
```php
// $psrLogger should be an instance of PSR-3 compatible logger.
// As an example, we'll use Monolog to send log to Slack.
$psrLogger = new \Monolog\Logger('my_logger');
$psrLogger->pushHandler(new \Monolog\Handler\SlackHandler('slack_token', 'logs', null, true, null, \Monolog\Logger::DEBUG));
return [
// ...
'bootstrap' => ['log'],
// ...
'components' => [
// ...
'log' => [
'targets' => [
[
'class' => 'samdark\log\PsrTarget',
'logger' => $psrLogger,
// It is optional parameter. The message levels that this target is interested in.
// The parameter can be an array.
'levels' => ['info', yii\log\Logger::LEVEL_WARNING, Psr\Log\LogLevel::CRITICAL],
// It is optional parameter. Default value is false. If you use Yii log buffering, you see buffer write time, and not real timestamp.
// If you want write real time to logs, you can set addTimestampToContext as true and use timestamp from log event context.
'addTimestampToContext' => true,
],
// ...
],
],
],
];
```
Standard usage:
```php
Yii::info('Info message');
Yii::error('Error message');
```
Usage with PSR logger levels:
```php
Yii::getLogger()->log('Critical message', Psr\Log\LogLevel::CRITICAL);
Yii::getLogger()->log('Alert message', Psr\Log\LogLevel::ALERT);
```
Usage with original timestamp from context in the log:
```php
// $psrLogger should be an instance of PSR-3 compatible logger.
// As an example, we'll use Monolog to send log to Slack.
$psrLogger = new \Monolog\Logger('my_logger');
$psrLogger->pushProcessor(function($record) {
if (isset($record['context']['timestamp'])) {
$dateTime = DateTime::createFromFormat('U.u', $record['context']['timestamp']);
$timeZone = $record['datetime']->getTimezone();
$dateTime->setTimezone($timeZone);
$record['datetime'] = $dateTime;
unset($record['context']['timestamp']);
}
return $record;
});
```
You can use PsrMessage instead of regular string messages to add custom context.
Standard usage:
```php
Yii::error(new \samdark\log\PsrMessage("Critical message", [
'custom' => 'context',
'key' => 'value',
]));
```
Usage with PSR logger Levels:
```php
Yii::getLogger()->log(new \samdark\log\PsrMessage("Critical message", [
'important' => 'context'
]), Psr\Log\LogLevel::CRITICAL);
```
Usage with PSR-3 log message processing:
```php
$psrLogger = new \Monolog\Logger('my_logger');
$psrLogger->pushProcessor(new \Monolog\Processor\PsrLogMessageProcessor());
```
```php
Yii::debug(new \samdark\log\PsrMessage("Greetings from {fruit}", [
'fruit' => 'banana'
]));
```
## Running tests
In order to run tests perform the following commands:
```
composer install
./vendor/bin/phpunit
```