vasek-purchart/console-errors-bundle

Logging of exceptions and error codes for Symfony Console

3.0.2 2022-05-17 14:48 UTC

Requires

• php: ~7.2
• psr/log: ~1.0
• symfony/config: ~4.0
• symfony/console: ~4.0
• symfony/dependency-injection: ~4.0
• symfony/http-kernel: ~4.0
• symfony/yaml: ~4.0

Requires (Dev)

• consistence/coding-standard: 3.10.1
• matthiasnoback/symfony-dependency-injection-test: 4.3
• phing/phing: 2.17.2
• php-parallel-lint/php-console-highlighter: 1.0
• php-parallel-lint/php-parallel-lint: 1.3.2
• phpunit/phpunit: 8.5.25

MIT

• Vašek Purchart

• logging
• symfony
• debug
• exception
• error
• bundle
• console

README

Logging of exceptions and error codes for Symfony Console.

This bundle ensures all uncaught exceptions and errors are logged in the same way as exceptions from controllers.

It also logs all command executions which ended with non-zero exit code.

Here is an example showing an exception, error and non-zero exit code:

And these are corresponding log entries:

[2015-05-19 12:41:19] app.ERROR: Exception: Hello Exception! (uncaught exception) at /home/vasek/dev/projects/console-errors-bundle/framework-standard-edition/src/AppBundle/Console/HelloCommand.php line 23 while running console command `hello:world` {"exception":"[object] (Exception(code: 0): Hello Exception! at /home/vasek/dev/projects/console-errors-bundle/framework-standard-edition/src/AppBundle/Console/HelloCommand.php:23)"} []
[2015-05-19 12:41:58] app.ERROR: Symfony\Component\Debug\Exception\ContextErrorException: Notice: Undefined variable: foo (uncaught exception) at /home/vasek/dev/projects/console-errors-bundle/framework-standard-edition/src/AppBundle/Console/HelloCommand.php line 23 while running console command `hello:world` {"exception":"[object] (Symfony\\Component\\Debug\\Exception\\ContextErrorException(code: 0): Notice: Undefined variable: foo at /home/vasek/dev/projects/console-errors-bundle/framework-standard-edition/src/AppBundle/Console/HelloCommand.php:23)"} []
[2015-05-19 12:42:13] app.ERROR: Command `hello:world` exited with status code 123 [] []

Configuration

Configuration structure with listed default values:

# config/packages/console_errors.yml
console_errors:
    exceptions:
        # Enable logging for exceptions.
        enabled: true
        # Log level with which exceptions should be logged (accepts string or integer values).
        log_level: error
        # Priority with which the listener will be registered.
        listener_priority: 0

    exit_code:
        # Enable logging for non-zero exit codes.
        enabled: true
        # Log level with which exit codes should be logged (accepts string or integer values).
        log_level: error
        # Priority with which the listener will be registered.
        listener_priority: 0

Symfony by default always converts errors to PHP exceptions. Warnings and notices are converted by default only in development environment. If you want to configure your application to always convert warnings and notices to exceptions use the debug.error_handler.throw_at parameter (see PHP manual for other available values):

# config/packages/framework.yml
parameters:
    debug.error_handler.throw_at: -1

You can also override services used internally, for example if you use a non standard logger, you can provide custom instance with an alias:

services:
    my_logger:
        class: 'Monolog\Logger'
        arguments:
            - 'my_channel'

    vasek_purchart.console_errors.console.logger: '@my_logger'

Installation

Install package vasek-purchart/console-errors-bundle with Composer:

composer require vasek-purchart/console-errors-bundle

Register the bundle in your application:

// config/bundles.php
return [
	// ...
	VasekPurchart\ConsoleErrorsBundle\ConsoleErrorsBundle::class => ['all' => true],
];