Як логувати повідомлення у різні файли

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

Як логувати повідомлення у різні файли

Фреймворк Symfony організовує повідомлення логів у канали. За замовчуванням, існує декілька каналів, включно з doctrine, event, security, request та інші. Канал друкується у повідомленні логу і може також бути використаний для спрямування різних каналів у різні місця/файли.

За замовчуванням, Symfony записує кожне повідомлення в один і той же файл (незалежно від каналу).

Note

Кожний канал відповідає сервісу логування (monolog.logger.XXX) у контейнері (використайте команду debug:container, щоб побачити повний перелік) і вони впроваджуються у різні сервіси.

Перемикання каналу на інший обробник

Тепер, уявіть, що ви хочете логувати канал security в інший файл. Щоб зробити це, створіть новий обробник та сконфігуруйте його, щоб він логував лише повідомлення з каналу security. Наступний приклад робить це лише у prod середовищі конфігурації , але ви можете зробити це у будь-якому (або всіх) середовищах:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        # config/packages/prod/monolog.yaml
monolog:
    handlers:
        security:
            # логувати всі повідомлення (так як налагодження є найнижчим рівнем)
            level:    debug
            type:     stream
            path:     '%kernel.logs_dir%/security.log'
            channels: [security]

        # приклад *відсутності* локгування повідомлень каналу безпеки для цього обробника
        main:
            # ...
            # channels: ['!security']
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
        <!-- config/packages/prod/monolog.xml-->
<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="security" type="stream" path="%kernel.logs_dir%/security.log">
            <monolog:channels>
                <monolog:channel>security</monolog:channel>
            </monolog:channels>
        </monolog:handler>

        <monolog:handler name="main" type="stream" path="%kernel.logs_dir%/main.log">
            <!-- ... -->
            <monolog:channels>
                <monolog:channel>!security</monolog:channel>
            </monolog:channels>
        </monolog:handler>
    </monolog:config>
</container>
    

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

return static function (MonologConfig $monolog) {
    $monolog->handler('security')
        ->type('stream')
        ->path('%kernel.logs_dir%/security.log')
        ->channels()->elements(['security']);

    $monolog->handler('main')
         // ...

        ->channels()->elements(['!security']);
};
    

Caution

Конфігурація channels працює лише для обробників найвищого рівня. Обробники, які вкладені у групу, буфер, фільтр, fingers crossed абощось подібне, ігноруватимуть цю конфігурацію та обробляти кожне передане їм повідомлення.

Специфікація YAML

Ви можете вказати конфігурацію у багатьох формах:

        1
2
3
4
5
6
7
        channels: ~    # Включити всі канали

channels: foo  # Включити лише канал 'foo'
channels: '!foo' # Включити всі канали, окрім 'foo'

channels: [foo, bar]   # Включити лише канали 'foo' та 'bar'
channels: ['!foo', '!bar'] # Включити всі канали, окрім 'foo' та 'bar'
    

Створення вашого власного каналу

Ви можете змінити канал запиму логів Monolog по одному сервісу за раз. Це робиться за допомогою тегування вашого сервісу monolog.logger та вказання того, в якому каналі сервіс має записувати логи. З тегом, обробник логів, який впроваджується в сервіс, попередньо сконфігурований так, щоб використовувати канал, який ви вказали.

Конфігурація додаткових каналів без тегованих сервісів

Ви також можете сконфігурувати додаткові канали без необхідності тегувати ваші сервіси:

YAML
XML
PHP

        1
2
3
        # config/packages/monolog.yaml
monolog:
    channels: ['foo', 'bar']
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/packages/monolog.xml -->
<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
        http://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/monolog
        http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

    <monolog:config>
        <monolog:channel>foo</monolog:channel>
        <monolog:channel>bar</monolog:channel>
    </monolog:config>
</container>
    

        1
2
3
4
5
6
7
        // config/packages/monolog.php
$container->loadFromExtension('monolog', array(
    'channels' => array(
        'foo',
        'bar',
    ),
));
    

Symfony автоматично реєструє по одному сервісу на канал (у цьому прикладі, канал foo створює сервіс під назвою monolog.logger.foo). Для того, щоб впровадити цей сервіс у інші, ви повинні оновити конфігурацію сервісу, щоб обрати конкретний сервіс для впровадження .

Як автомонтувати канали логерів

Починаючи з MonologBundle 3.5, ви можете автомонтувати різні канали Monolog, додавши підказки у ваші аргументи сервісу з наступним синтаксисом: Psr\Log\LoggerInterface $<camelCased channel name> + Logger. <channel> має бути попередньо визначений у вашій конфігурації Monolog .

Наприклад, щоб впрповадити сервіс, повʼязаний з каналом логеру foo_bar, змініть ваш конструктор таким чином:

        1
2
3
4
5
        -     public function __construct(LoggerInterface $logger)
+     public function __construct(LoggerInterface $fooBarLogger)
    {
        $this->logger = $fooBarLogger;
    }
    