sbooker/yii2-monolog

The Monolog integration for the Yii framework.

0.2.2 2017-06-06 09:44 UTC

Requires

• monolog/monolog: ^1.20
• yiisoft/yii2: *

Requires (Dev)

• phpunit/phpunit: ~4.5
• phpunit/phpunit-mock-objects: 2.3.0
• satooshi/php-coveralls: ~1.0
• yiisoft/yii2-mongodb: ^2.1

Suggests

• yiisoft/yii2-mongodb: Allow sending log messages to a MongoDB server using Yii2 connection

MIT

• Sergey Knigin

• log
• logging
• monolog
• yii2

README

The Monolog integration for the Yii framework.

Requirements

• PHP 5.4 or above
• Yii 2.0.0 or above

Instalation with composer

1. Open your project directory;
2. Run composer require sbooker/yii2-monolog to add Monolog in your project vendor.

Configuration

To configure Monolog component in Yii2, use the structure exemplified below. The channel "main" is required in component and used when no channel is setted to use a logger.

return [
    //....
    'components' => [
        'monolog' => [
            'class' => '\Mero\Monolog\MonologComponent',
            'handlers' => [
                'main' => [
                    'type' => 'stream',
                    'path' => '@app/runtime/logs/main.log',
                    'level' => 'debug',
                    'channels' => [ 'main', ]
                ],
            ],
            'processor' = [
                'logProcessor', // id in ServiceLocator or Container
            ]
        ],
    ],
    //....
];

You can configure multiple channels and different handlers and processors for each channel.

Handlers

You can add handlers in their channels using the array structure or object structure.

Array structure

Using the array structure, you have a better readability of the configuration of their handlers.

Example

return [
    //...
    'handler' => [
        [
            'type' => 'stream',
            'path' => '@app/runtime/logs/log_' . date('Y-m-d') . '.log',
            'level' => 'debug'
        ]
    ],
    //...
];

Warning: this option does not have any existing handlers in monolog. See the handlers page more details.

Object structure

Using the object structure, you will be informing instantiated objects already declared their respective handlers.

Example

return [
    //...
    'handler' => [
        new \Monolog\Handler\StreamHandler(
            __DIR__.'/../runtime/logs/system.log',
            \Monolog\Logger::DEBUG
        )
    ],
    //...
];

Using Yii2 Monolog

To use Yii 2 Monolog simply call the method getLogger component informing which channel is used.

Example

namespace app\controllers;

use Yii;
use \yii\web\Controller;

class ExampleController extends Controller
{

    /**
     * This action register "Hello world" in channel 
     * "main"(default when no value is setted on "getLogger" method).
     */
    public function actionFirstExample()
    {
        $monologComponent = Yii::$app->monolog;
        $logger = $monologComponent->getLogger();
        $logger->log('info', 'Hello world');
    }

    /**
     * This action register "Hello world" in channel "channel1".
     */
    public function actionSecondExample()
    {
        $monologComponent = Yii::$app->monolog;
        $logger = $monologComponent->getLogger("channel1");
        $logger->log('info', 'Hello world');
    }
    
}