8000 [Logger] Switching to more modern config format by ThomasLandauer · Pull Request #19308 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content
8000

[Logger] Switching to more modern config format #19308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2023
Merged

[Logger] Switching to more modern config format #19308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 38 additions & 33 deletions logging/channels_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,27 @@ 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. The following example does that only in the
``prod`` :ref:`configuration environment <configuration-environments>` but you
can do it in any (or all) environments:
``prod`` :ref:`configuration environment <configuration-environments>`:

.. configuration-block::

.. code-block:: yaml

# 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']
# config/packages/monolog.yaml
when@prod:
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']

.. code-block:: xml

Expand All @@ -56,12 +56,14 @@ can do it in any (or all) environments:
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>
<when env="prod">
<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>
</when>

<monolog:handler name="main" type="stream" path="%kernel.logs_dir%/main.log">
<!-- ... -->
Expand All @@ -75,18 +77,21 @@ can do it in any (or all) environments:
.. code-block:: php

// config/packages/prod/monolog.php
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Config\MonologConfig;

return static function (MonologConfig $monolog) {
$monolog->handler('security')
->type('stream')
->path('%kernel.logs_dir%/security.log')
->channels()->elements(['security']);
return static function (MonologConfig $monolog, ContainerConfigurator $container) {
if ('prod' === $container->env()) {
$monolog->handler('security')
->type('stream')
->path(param('kernel.logs_dir') . \DIRECTORY_SEPARATOR . 'security.log')
->channels()->elements(['security']);

$monolog->handler('main')
// ...
$monolog->handler('main')
// ...

->channels()->elements(['!security']);
->channels()->elements(['!security']);
}
};

.. caution::
Expand Down Expand Up @@ -131,13 +136,13 @@ You can also configure additional channels without the need to tag your services

.. code-block:: yaml

# config/packages/prod/monolog.yaml
# config/packages/monolog.yaml
monolog:
channels: ['foo', 'bar', 'foo_bar']

.. code-block:: xml

<!-- config/packages/prod/monolog.xml -->
<!-- config/packages/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"
Expand All @@ -155,7 +160,7 @@ You can also configure additional channels without the need to tag your services

.. code-block:: php

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

return static function (MonologConfig $monolog) {
Expand Down
0