How to Configure Monolog to Display Console Messages

It is possible to use the console to print messages for certain verbosity levels using the OutputInterface instance that is passed when a command is run.

When a lot of logging has to happen, it's cumbersome to print information depending on the verbosity settings (-v, -vv, -vvv) because the calls need to be wrapped in conditions. For example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use Symfony\Component\Console\Output\OutputInterface;

public function __invoke(OutputInterface $output): int
{
    if ($output->isDebug()) {
        $output->writeln('Some info');
    }

    if ($output->isVerbose()) {
        $output->writeln('Some more info');
    }

    // ...
}

Instead of using these semantic methods to test for each of the verbosity levels, the MonologBridge provides a ConsoleHandler that listens to console events and writes log messages to the console output depending on the current log level and the console verbosity.

The example above could then be rewritten as:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// src/Command/MyCommand.php
namespace App\Command;

use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;

#[AsCommand(name: 'app:my-command')]
class MyCommand
{
    public function __construct(
        private LoggerInterface $logger,
    ) {
    }

    public function __invoke(): int
    {
        $this->logger->debug('Some info');
        $this->logger->notice('Some more info');

        return Command::SUCCESS;
    }
}

Depending on the verbosity level that the command is run in and the user's configuration (see below), these messages may or may not be displayed to the console. If they are displayed, they are time-stamped and colored appropriately. Additionally, error logs are written to the error output (php://stderr). There is no need to conditionally handle the verbosity settings anymore.

The Monolog console handler is enabled by default:

1
2
3
4
5
6
7
8
9
10
11
12
13

# config/packages/monolog.yaml
when@dev:
    monolog:
        handlers:
            # ...
            console:
                type:   console
                process_psr_3_messages: false
                channels: ['!event', '!doctrine', '!console']

                # optionally configure the mapping between verbosity levels and log levels
                # verbosity_levels:
                #     VERBOSITY_NORMAL: NOTICE

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// config/packages/monolog.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return App::config([
    'when@dev' => [
        'monolog' => [
            'handlers' => [
                'console' => [
                    'type' => 'console',
                    'process_psr_3_messages' => false,
                    'channels' => ['!event', '!doctrine', '!console'],

                    // optionally configure the mapping between verbosity levels and log levels
                    // 'verbosity_levels' => [
                    //     'VERBOSITY_NORMAL' => 'NOTICE',
                    // ],
                ],
            ],
        ],
    ],
]);

Now, log messages will be shown on the console based on the log levels and verbosity. By default (normal verbosity level), warnings and higher will be shown. But in full verbosity mode, all messages will be shown.

1
2
3
4
5
6
7
8
9

# display only the logs of the "http_client" channel
$ SYMFONY_CONSOLE_LOG_CHANNELS=http_client php bin/console app:import -vvv

# display the logs of several channels (use a comma-separated list)
$ SYMFONY_CONSOLE_LOG_CHANNELS=app,http_client php bin/console app:import -vvv

# display the logs of all channels except some (prefix them with "!")
# (you can't mix included and excluded channels in the same list)
$ SYMFONY_CONSOLE_LOG_CHANNELS='!php,!cache' php bin/console app:import -vvv

1
2
3
4
5
6
7
8

# config/packages/dev/monolog.yaml
monolog:
    handlers:
        console:
            type: console
            process_psr_3_messages: false
            channels: ['!event', '!doctrine', '!console']
            interactive_only: true

1
2
3
4
5
6
7
8
9
10
11

// config/packages/dev/monolog.php
use Symfony\Config\MonologConfig;

return static function (MonologConfig $monolog): void {
    $monolog->handler('console')
        ->type('console')
        ->processPsr3Messages(false)
        ->interactiveOnly(true)
        ->channels()->elements(['!event', '!doctrine', '!console'])
    ;
};