Skip to content

Introduce dedicated logger channel for deprecations #13642

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

Closed
wants to merge 2 commits into from
Closed

Introduce dedicated logger channel for deprecations #13642

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
746d9c9
Add precision about deprecations triggered during warm-up process
l-vo May 5, 2020
e4a78d9
Introduce dedicated logger channel for deprecations
l-vo May 5, 2020
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
51 changes: 50 additions & 1 deletion setup/upgrade_major.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ using these deprecated features in the last version before the major (e.g.
you should first :doc:`upgrade to the last minor version </setup/upgrade_minor>`
(e.g. 4.4) so that you can see *all* the deprecations.

Deprecations in Web Debug Toolbar
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To help you find deprecations, notices are triggered whenever you end up
using a deprecated feature. When visiting your application in the
:ref:`dev environment <configuration-environments>`
Expand Down Expand Up @@ -84,7 +87,7 @@ Now, you can start fixing the notices:
OK (10 tests, 20 assertions)

Remaining deprecation notices (6)

The "request" service is deprecated and will be removed in 3.0. Add a type-hint for
Symfony\Component\HttpFoundation\Request to your controller parameters to retrieve the
request instead: 6x
Expand All @@ -95,6 +98,10 @@ Now, you can start fixing the notices:
Once you fixed them all, the command ends with ``0`` (success) and you're
done!

.. note::

Since some deprecations may be triggered during the cache warm-up, it's recommanded to run your final deprecation check with an empty cache.

.. sidebar:: Using the Weak Deprecations Mode

Sometimes, you can't fix all deprecations (e.g. something was deprecated
Expand All @@ -120,6 +127,48 @@ done!

$ SYMFONY_DEPRECATIONS_HELPER=max[total]=999999 php ./bin/phpunit

Deprecations in logs
~~~~~~~~~~~~~~~~~~~~
If you use the Symfony default configuration, a part of the ``monolog`` configuration for the prod environment can be uncommented allowing to log deprecations in a ``prod.deprecations.log`` file:

.. code-block:: yaml

monolog:
handlers:
# ...
deprecation:
type: stream
path: "%kernel.logs_dir%/%kernel.environment%.deprecations.log"
deprecation_filter:
type: filter
handler: deprecation
max_level: info
channels: ["php"]

Under the hood, deprecations are logged on the ``php`` Monolog channel at ``INFO`` psr-3 level. But as soon as an extra ``deprecation`` channel exists; deprecations are logged into this channel instead. So you can log deprecations on this dedicated channel and make the ``deprecation_filter`` useless:

.. code-block:: yaml

monolog:
channels:
- deprecation
handlers:
# ...
deprecation:
type: stream
channels: ["deprecation"]
path: "%kernel.logs_dir%/%kernel.environment%.deprecations.log"

.. versionadded:: 5.1

The deprecation logging into a dedicated channel was introduced in Symfony 5.1.

Road to Code Deprecation Free
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Track the deprecations from the PHPUnit bridge and/or (depending on your test coverage) browse your application and note the deprecations on the web debug toolbar.
2. Deploy your code (that should not have deprecations anymore) on production and check from time to time the content of this log file to be aware of the remaining deprecations you have to change/update.
3. When you're sure there is no more deprecations, follow the steps below to upgrade your application.

.. _upgrade-major-symfony-composer:

2) Update to the New Major Version via Composer
Expand Down