Як сконфігурувати Monolog так, щоб він надсилав помилки електронною поштою

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

Як сконфігурувати Monolog так, щоб він надсилав помилки електронною поштою

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

YAML
XML
PHP

        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
        # config/packages/prod/monolog.yaml
monolog:
    handlers:
        mail:
            type:         fingers_crossed
            # на критичному рівні логується 500 помилок
            action_level: critical
            # щоб також логувати 400 рівень помилок (але не помилок 404):
            # action_level: error
            # excluded_404s:
            #     - ^/
            handler:      deduplicated
        deduplicated:
            type:    deduplication
            handler: swift
        swift:
            type:       swift_mailer
            from_email: 'error@example.com'
            to_email:   'error@example.com'
            # або список отримувачів
            # to_email:   ['dev1@example.com', 'dev2@example.com', ...]
            subject:    'An Error Occurred! %%message%%'
            level:      debug
            formatter:  monolog.formatter.html
            content_type: text/html
    

        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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
        <!-- 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
        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>
        <!--
        на критичному рівні логується 500 помилок
        щоб також логувати 400 рівень помилок (але не помилок 404):
        action-level="error"
        І додайте цю доньку всередину monolog:handler
        <monolog:excluded-404>^/</monolog:excluded-404>
        -->
        <monolog:handler
            name="mail"
            type="fingers_crossed"
            action-level="critical"
            handler="deduplicated"
        />
        <monolog:handler
            name="deduplicated"
            type="deduplication"
            handler="swift"
        />
        <monolog:handler
            name="swift"
            type="swift_mailer"
            from-email="error@example.com"
            subject="An Error Occurred! %%message%%"
            level="debug"
            formatter="monolog.formatter.html"
            content-type="text/html">

            <monolog:to-email>error@example.com</monolog:to-email>

            <!-- або список отримувачів -->
            <!--
            <monolog:to-email>dev1@example.com</monolog:to-email>
            <monolog:to-email>dev2@example.com</monolog:to-email>
            ...
            -->
        </monolog:handler>
    </monolog:config>
</container>
    

        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
        // config/packages/prod/monolog.php
$container->loadFromExtension('monolog', array(
    'handlers' => array(
        'mail' => array(
            'type'         => 'fingers_crossed',
            // на критичному рівні логується 500 помилок
            'action_level' => 'critical',
            // щоб також логувати 400 рівень помилок (але не помилок 404):
            // 'action_level' => 'error',
            // 'excluded_404s' => array(
            //     '^/',
            // ),
            'handler'      => 'deduplicated',
        ),
        'deduplicated' => array(
            'type'    => 'deduplication',
            'handler' => 'swift',
        ),
        'swift' => array(
            'type'         => 'swift_mailer',
            'from_email'   => 'error@example.com',
            'to_email'     => 'error@example.com',
            // або список отримувачів
            // 'to_email'   => array('dev1@example.com', 'dev2@example.com', ...),
            'subject'      => 'An Error Occurred! %%message%%',
            'level'        => 'debug',
            'formatter'    => 'monolog.formatter.html',
            'content_type' => 'text/html',
        ),
    ),
));
    

Обробник mail - це обробник fingers_crossed, що означає, що він запускається лише коли досягнуто рівень дії, у цьому випадку - critical. Рівень critical запускається лише для помилок HTTP-коду 5xx. Якщо цей рівень досягнуто один раз, обробник fingers_crossed буде логувати всі повідомлення, не зважаючи на їх рівень. Налаштування handler означає, що виведення потім передається в обробник deduplicated.

Tip

Якщо ви хочете, щоб помилки і 400, і 500 рівнів викликали надсиалння листа, встановіть action_level у значенні error замість critical. Див. код вище, щоб побачити приклад.

Обробник deduplicated просто зберігає всі повідомлення для запиту, а потім передає їх у вкладний обробник за один раз, але лише якщо записи унікальні протягом заданого періоду часу (за замовчуванням - 60 секунд). Якщо записи є дублікатами, то вони просто скидаютьсся. Додавання цього обробника зменшує обяг сповіщень до керованого рівня, особливо у сценаріях критичної відмови. Ви можете налаштувати часовий проміжок, використовуючи опцію time:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
        # config/packages/prod/monolog.yaml
monolog:
    handlers:
        # ...
        deduplicated:
            type: deduplication
            # час в секундах, протягом якого видаляються дубльовані записи (за замовчуванням: 60)
            time: 10
            handler: swift
    

        1
2
3
4
5
6
7
        <!-- config/packages/prod/monolog.xml -->

<!-- час: час в секундах, протягом якого видаляються дубльовані записи (за замовчуванням: 60) -->
<monolog:handler name="deduplicated"
    type="deduplication"
    time="10"
    handler="swift" />
    

        1
2
3
4
5
6
7
8
9
10
        // config/packages/prod/monolog.php
$container->loadFromExtension('monolog', array(
    'handlers' => array(
        // ...
        'deduplicated' => array(
            'type'    => 'deduplication',
            // час в секундах, протягом якого видаляються дубльовані записи (за замовчуванням: 60)
            'time' => 10,
            'handler' => 'swift',
         )
    

Потім повідомлення передаються обробнику swift. Це той обробник, який працює з відправленням вам листа помилково. Його установки прості та зрозумілі: адреса відправника та отримувача, форматувальник, тип змісту та субʼєкт.

Ви можете комбінувати ці обробники з іншими, щоб помилки продовжували логуватися на сервері, а електронні листи продовжували надсилатися:

YAML
XML
PHP

        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
        # config/packages/prod/monolog.yaml
monolog:
    handlers:
        main:
            type:         fingers_crossed
            action_level: critical
            handler:      grouped
        grouped:
            type:    group
            members: [streamed, deduplicated]
        streamed:
            type:  stream
            path:  '%kernel.logs_dir%/%kernel.environment%.log'
            level: debug
        deduplicated:
            type:    deduplication
            handler: swift
        swift:
            type:       swift_mailer
            from_email: 'error@example.com'
            to_email:   'error@example.com'
            subject:    'An Error Occurred! %%message%%'
            level:      debug
            formatter:  monolog.formatter.html
            content_type: text/html
    

        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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
        <!-- 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
        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:handler
            name="main"
            type="fingers_crossed"
            action_level="critical"
            handler="grouped"
        />
        <monolog:handler
            name="grouped"
            type="group"
        >
            <member type="stream"/>
            <member type="deduplicated"/>
        </monolog:handler>
        <monolog:handler
            name="stream"
            path="%kernel.logs_dir%/%kernel.environment%.log"
            level="debug"
        />
        <monolog:handler
            name="deduplicated"
            type="deduplication"
            handler="swift"
        />
        <monolog:handler
            name="swift"
            type="swift_mailer"
            from-email="error@example.com"
            subject="An Error Occurred! %%message%%"
            level="debug"
            formatter="monolog.formatter.html"
            content-type="text/html">

            <monolog:to-email>error@example.com</monolog:to-email>

            <!-- або список отримувачів -->
            <!--
            <monolog:to-email>dev1@example.com</monolog:to-email>
            <monolog:to-email>dev2@example.com</monolog:to-email>
            ...
            -->
        </monolog:handler>
    </monolog:config>
</container>
    

        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
        // config/packages/prod/monolog.php
$container->loadFromExtension('monolog', array(
    'handlers' => array(
        'main' => array(
            'type'         => 'fingers_crossed',
            'action_level' => 'critical',
            'handler'      => 'grouped',
        ),
        'grouped' => array(
            'type'    => 'group',
            'members' => array('streamed', 'deduplicated'),
        ),
        'streamed'  => array(
            'type'  => 'stream',
            'path'  => '%kernel.logs_dir%/%kernel.environment%.log',
            'level' => 'debug',
        ),
        'deduplicated' => array(
            'type'     => 'deduplication',
            'handler'  => 'swift',
        ),
        'swift' => array(
            'type'         => 'swift_mailer',
            'from_email'   => 'error@example.com',
            'to_email'     => 'error@example.com',
            // або список отримувачів
            // 'to_email'   => array('dev1@example.com', 'dev2@example.com', ...),
            'subject'      => 'An Error Occurred! %%message%%',
            'level'        => 'debug',
            'formatter'    => 'monolog.formatter.html',
            'content_type' => 'text/html',
        ),
    ),
));
    

Використовується обробник group для відправлення повідомлень двом членам групи, обробники deduplicated і stream. Тепер обидва повідомлення будуть записані у файл логів і відправлені електронною поштою.