deamon/logger-extra-bundle

This bundle is here to add some extra info about the context in your logs.

v6.1.0 2022-08-03 14:18 UTC

Requires

• php: >=8.0.2
• monolog/monolog: ^3.0
• symfony/config: ^6.0
• symfony/dependency-injection: ^6.0
• symfony/http-foundation: ^6.0
• symfony/http-kernel: ^6.0
• symfony/monolog-bridge: ^6.0
• symfony/security-core: ^6.0

Requires (Dev)

• symfony/phpunit-bridge: ^6.0

Suggests

• graylog2/gelf-php: For the possibility to send monolog messages to a graylog server such as ELK

MIT

• Bastien DURAND
• Contributors

• log

README

This project is used to add extra context information in your logs.

If you need compatibility with previous Symfony versions, have a look at previous releases.

Requirements

php >=8.0.2

symfony/security-core symfony/dependency-injection symfony/monolog-bridge symfony/http-kernel symfony/http-foundation symfony/config

Compatible with Symfony starting from 6.0.
Tags follow Symfony versions.

Installation

You need to add a package to your dependency list :

    // composer.json
    "deamon/logger-extra-bundle": "^6.0"

Then enable the bundle into your kernel

    // config/bundles.php
    return [
        // ...
        App\Acme\TestBundle\AcmeTestBundle::class => ['all' => true],
    ];

Finally you need to configure the bundle.

Config Example

Given this config sample of a project:

// config/packages/monolog.yml
monolog:
    handlers:
        main:
            type: stream
            path: "%kernel.logs_dir%/%kernel.environment%.log"
            level: debug
            channels: ["!event"]

With this example of monolog config, you can configure this bundle to only add extra info on main handler.

// config/packages/deamon_logger_extra.yml
deamon_logger_extra:
    application:  
        name: "loc-deamonfront"
        version: "v0.1"
    handlers: [main]

Config reference

// config/packages/deamon_logger_extra.yaml
deamon_logger_extra:
    application:
        name: "loc-deamonfront" # default to null
        locale: "fr" # default to null
        version: "v0.1" # default to null
    handlers: [main] # the only required field
    config:
        channel_prefix: "v0.1" # default to null
        user_class: "\\Symfony\\\Component\\Security\\Core\\User\\UserInterface" # default to null
        user_methods:
            user_name: getUsername # default value
        display:
            env: false # default to true
            locale: false # default to true
            application_name: false # default to true
            url: false # default to true
            route: false # default to true
            user_agent: false # default to true
            accept_encoding: false # default to true
            client_ip: false # default to true
            user: false # default to true
            global_channel: false # default to true

Minimal configuration

// config/packages/deamon_logger_extra.yaml
deamon_logger_extra:
    application: null
    handlers: ['main']
    config: null