Как добавлять дополнительные данные в сообщения логов через процессор

Дата обновления перевода 2022-01-19

Как добавлять дополнительные данные в сообщения логов через процессор

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

    // this method is called for each log record; optimize it to not hurt performance
    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 }

Наконец, настройте форматировщик так, чтобы он был использован в любом желаемом вами обработчике:

  • 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

Если вы используете несколько обработчиков, вы также можете зарегистрировать процессор на уровне обработчика или канала, вместо того, чтобы регистрировать его глобально (см. следующие разделы).

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

DebugProcessor
Добавляет в запись дополнительную информацию, полезную для отладки, вроде временной отметки или сообщения об ошибке.
TokenProcessor
Добавляет в запись информацию из токена текущего пользователя, чтобы записать, а именно - имя пользователя, роли и является ли он аутентифицированным.
SwitchUserTokenProcessor

Добавляетинформацию о пользователе, который имитирует пользователя, выполнившего вход в систему, а именно - имя пользователя, роли и является ли он аутентифицированным.

5.2

SwitchUserTokenProcessor был представлен в Symfony 5.2.

WebProcessor
Переопределяет данные из запроса, используя данные внутри объекта запроса Symfony.
RouteProcessor
Добавляет информацию о текущем маршруте (контроллер, действие, параметры маршрута).
ConsoleCommandProcessor
Добавляет информацию о текущей команде консоли.

See also

Посмотрите на встроенные процессоры Monolog, чтобы узнать больше о том, как создавать такие процессоры.

Регистрация процессоров в обработчике

Вы можете зарегистрировать процессор в обработчике, используя опцию handler тега monolog.processor:

  • YAML
  • XML
  • PHP
1
2
3
4
5
# config/services.yaml
services:
    App\Logger\SessionRequestProcessor:
        tags:
            - { name: 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 }