Як додавати додаткові дані у повідомлення логів через процесор

Дата оновлення перекладу 2022-12-15

Як додавати додаткові дані у повідомлення логів через процесор

Monolog дозволяє вам обробляти кожний запис до того, як записувати його у логи, додаючи додаткові дані. Це роль процесора, яка може бути застосована до всього стеку обробника або лишедо конкретного обробника чи каналу.

Процесор - це викличне, яке отримує запис в якості першого аргументу. Процесори конфігуруються з використанням DIC-тегу monolog.processor. Дивіться довідник з нього .

Додавання токену сесії/запиту

Іноді складно сказати, до якої сесії та/або запиту належать записи у логу. Наступний приклад додасть унікальний токен до кожного запиту, використовуючи процесор:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
        // src/Logger/SessionRequestProcessor.php
namespace App\Logger;

use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
use Symfony\Component\HttpFoundation\RequestStack;

class SessionRequestProcessor
{
    private $requestStack;

    public function __construct(RequestStack $requestStack)
    {
        $this->requestStack = $requestStack;
    }

    // цей метод викликається для кожного запису логу; оптимізуйте його, щоб не шкодити продуктивності
    public function __invoke(array $record)
    {
        try {
            $session = $this->requestStack->getSession();
        } catch (SessionNotFoundException $e) {
            return;
        }
        if (!$session->isStarted()) {
            return $record;
        }

        $sessionId = substr($session->getId(), 0, 8) ?: '????????';

        $record['extra']['token'] = $sessionId.'-'.substr(uniqid('', true), -8);

        return $record;
    }
}
    

Далі, зареєструйте ваш клас як сервіс, а також форматувальник, який використовує додаткову інформацію:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
        # config/services.yaml
services:
    monolog.formatter.session_request:
        class: Monolog\Formatter\LineFormatter
        arguments:
            - "[%%datetime%%] [%%extra.token%%] %%channel%%.%%level_name%%: %%message%% %%context%% %%extra%%\n"

    App\Logger\SessionRequestProcessor:
        tags:
            - { name: monolog.processor }
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:monolog="http://symfony.com/schema/dic/monolog"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/monolog
        https://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

    <services>
        <service id="monolog.formatter.session_request"
            class="Monolog\Formatter\LineFormatter">

            <argument>[%%datetime%%] [%%extra.token%%] %%channel%%.%%level_name%%: %%message%% %%context%% %%extra%%&#xA;</argument>
        </service>

        <service id="App\Logger\SessionRequestProcessor">
            <tag name="monolog.processor"/>
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
        // config/services.php
use App\Logger\SessionRequestProcessor;
use Monolog\Formatter\LineFormatter;

$container
    ->register('monolog.formatter.session_request', LineFormatter::class)
    ->addArgument('[%%datetime%%] [%%extra.token%%] %%channel%%.%%level_name%%: %%message%% %%context%% %%extra%%\n');

$container
    ->register(SessionRequestProcessor::class)
    ->addTag('monolog.processor');
    

Нарешті, налаштуйте форматувальник так, щоб він був використаний у будь-якому бажаному вами обробнику:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
        # config/packages/prod/monolog.yaml
monolog:
    handlers:
        main:
            type: stream
            path: '%kernel.logs_dir%/%kernel.environment%.log'
            level: debug
            formatter: monolog.formatter.session_request
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
        <!-- config/packages/prod/monolog.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:monolog="http://symfony.com/schema/dic/monolog"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/monolog
        https://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

    <monolog:config>
        <monolog:handler
            name="main"
            type="stream"
            path="%kernel.logs_dir%/%kernel.environment%.log"
            level="debug"
            formatter="monolog.formatter.session_request"
        />
    </monolog:config>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
        // config/packages/prod/monolog.php
use Symfony\Config\MonologConfig;

return static function (MonologConfig $monolog) {
    $monolog->handler('main')
        ->type('stream')
        ->path('%kernel.logs_dir%/%kernel.environment%.log')
        ->level('debug')
        ->formatter('monolog.formatter.session_request')
    ;
};
    

Якщо ви використовуєте декілька обробників, ви також можете зареєсрувати процесор на рівні обробника або каналу, замість того, щоб реєструвати його глобально (див. наступні розділи).

MonologBridge Symfony надає процесори, які можуть бути зареєстровані всередині вашого додатку.

DebugProcessor: Додає у запис додаткову інформацію, корисну для налагодження, на кшталт часової відмітки або повідомлення про помилку.
TokenProcessor: Додає у запис інформацію з токену поточного користувача, щоб записати, а саме - імʼя користувача, ролі і чи є він аутентифікованим.
SwitchUserTokenProcessor: Додає інформацію про користувача, який імітує користувача, що виконав вхід у систему, а саме - імʼя користувача, ролі і чи є він аутентифікованим.
WebProcessor: Перевизначає дані із запиту, використовуючи дані всередині обʼєкта запиту Symfony.
RouteProcessor: Додає інформацію про поточний маршрут (контролер, дію, параметри маршруту).
ConsoleCommandProcessor: Додає інформацію про поточну команду консолі.

Реєстрація процесорів в обробнику

Ви можете зареєсртувати процесор в обробнику, використовуючи опцію handler тегу monolog.processor:

YAML
XML
PHP

        1
2
3
4
5
        # config/services.yaml
services:
    App\Logger\SessionRequestProcessor:
        tags:
            - { name: monolog.processor, handler: main }
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:monolog="http://symfony.com/schema/dic/monolog"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/monolog
        https://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

    <services>
        <service id="App\Logger\SessionRequestProcessor">
            <tag name="monolog.processor" handler="main"/>
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
        // config/services.php

// ...
$container
    ->register(SessionRequestProcessor::class)
    ->addTag('monolog.processor', ['handler' => 'main']);
    

Реєстртація процесорів у каналі

Ви можете зареєструвати процесор у каналі, використовуючи опцію channel тегу monolog.processor:

YAML
XML
PHP

        1
2
3
4
5
        # config/services.yaml
services:
    App\Logger\SessionRequestProcessor:
        tags:
            - { name: monolog.processor, channel: main }
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:monolog="http://symfony.com/schema/dic/monolog"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/monolog
        https://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

    <services>
        <service id="App\Logger\SessionRequestProcessor">
            <tag name="monolog.processor" channel="main"/>
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
        // config/services.php

// ...
$container
    ->register(SessionRequestProcessor::class)
    ->addTag('monolog.processor', ['channel' => 'main']);
    