Skip to content

Document the new enabled option for Monolog handlers #21517

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

Open
wants to merge 2 commits into
base: 7.3
Choose a base branch
from
Open

Document the new enabled option for Monolog handlers #21517

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a5be4c
doc(loggin): add documentation for the enabled handler option
Arkalo2 Oct 20, 2025
996614d
Change the block type
Arkalo2 Oct 22, 2025
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
19 changes: 19 additions & 0 deletions logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,25 @@ which they are defined:

.. _logging-handler-fingers_crossed:


.. note::
Copy link
Member

@GromNaN GromNaN Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not use a note. That's feature.

Also, you should add .. versionadded:: 3.11

symfony-docs/logging/channels_handlers.rst

Lines 223 to 226 in f9c60f4

.. versionadded:: 3.5
The ``#[WithMonologChannel]`` attribute was introduced in Monolog 3.5.0.

Copy link
Author

@Arkalo2 Arkalo2 Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The versionadded is the Symfony version.
This is the linter error :

Error: You are not allowed to use version "3.11.0". Only major version "7" is allowed.
Error: Please only provide ".. versionadded::" if the version is greater/equal "7.0"


You can use the ``enabled`` option to enable or disable a handler depending
on the environment. For example, you can keep logging in ``dev`` and ``prod``
but disable it in ``staging``:

.. code-block:: yaml

monolog:
handlers:
file_log:
type: stream
path: "%kernel.logs_dir%/%kernel.environment%.log"
level: debug
enabled: false # disables the handler

When ``enabled`` is set to ``false``, the handler is completely ignored.

Handlers that Modify Log Entries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down