Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Logging
  4. How to Log Messages to different Files
WARNING:

You are browsing the documentation for Symfony 4.2 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.2.

How to Log Messages to different Files

4.2 version
Maintained
4.4 5.2 current 5.3 dev
Unmaintained
2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

How to Log Messages to different Files

The Symfony Framework organizes log messages into channels. By default, there are several channels, including doctrine, event, security, request and more. The channel is printed in the log message and can also be used to direct different channels to different places/files.

By default, Symfony logs every message into a single file (regardless of the channel).

Note

Each channel corresponds to a logger service (monolog.logger.XXX) in the container (use the php bin/console debug:container monolog command to see a full list) and those are injected into different services.

Switching a Channel to a different Handler

Now, suppose you want to log the security channel to a different file. To do this, create a new handler and configure it to log only messages from the security channel:

  • YAML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    # config/packages/prod/monolog.yaml
monolog:
    handlers:
        security:
            # log all messages (since debug is the lowest level)
            level:    debug
            type:     stream
            path:     '%kernel.logs_dir%/security.log'
            channels: [security]

        # an example of *not* logging security channel messages for this handler
        main:
            # ...
            # channels: ['!security']
  • XML
     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>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    // config/packages/prod/monolog.php
$container->loadFromExtension('monolog', [
    'handlers' => [
        'security' => [
            'type'     => 'stream',
            'path'     => '%kernel.logs_dir%/security.log',
            'channels' => [
                'security',
            ],
        ],
        'main'     => [
            // ...
            'channels' => [
                '!security',
            ],
        ],
    ],
]);

Caution

The channels configuration only works for top-level handlers. Handlers that are nested inside a group, buffer, filter, fingers crossed or other such handler will ignore this configuration and will process every message passed to them.

YAML Specification

You can specify the configuration by many forms:

1
2
3
4
5
6
7
channels: ~    # Include all the channels

channels: foo  # Include only channel 'foo'
channels: '!foo' # Include all channels, except 'foo'

channels: [foo, bar]   # Include only channels 'foo' and 'bar'
channels: ['!foo', '!bar'] # Include all channels, except 'foo' and 'bar'

Creating your own Channel

You can change the channel monolog logs to one service at a time. This is done either via the configuration below or by tagging your service with monolog.logger and specifying which channel the service should log to. With the tag, the logger that is injected into that service is preconfigured to use the channel you’ve specified.

Configure Additional Channels without Tagged Services

You can also configure additional channels without the need to tag your services:

  • YAML
    1
2
3
    # config/packages/prod/monolog.yaml
monolog:
    channels: ['foo', 'bar']
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <!-- 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:channel>foo</monolog:channel>
        <monolog:channel>bar</monolog:channel>
    </monolog:config>
</container>
  • PHP
    1
2
3
4
5
6
7
    // config/packages/prod/monolog.php
$container->loadFromExtension('monolog', [
    'channels' => [
        'foo',
        'bar',
    ],
]);

Symfony automatically registers one service per channel (in this example, the channel foo creates a service called monolog.logger.foo). In order to inject this service into others, you must update the service configuration to choose the specific service to inject.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.