deamon/logger-extra-bundle

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

Installs: 2 581

Dependents: 0

Suggesters: 0

Stars: 3

Watchers: 1

Forks: 4

Open Issues: 0

Type:symfony-bundle

v4.0.2 2018-10-29 14:57 UTC

README

Build Status Scrutinizer Code Quality Code Coverage symfony version php version

SensioLabsInsight

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 >=7.1

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

Compatible with Symfony starting from 4.0

Installation

You need to add a package to your dependency list :

    // composer.json
    "deamon/logger-extra-bundle": "^4.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"
    handlers: [main]
    config:
        channel_prefix: "v0.1"

Config reference

// config/packages/deamon_logger_extra.yaml
deamon_logger_extra:
    application:
        name: "loc-deamonfront" # default to null
        locale: "fr" # 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: ~
    handlers: 'main'
    config: ~