NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.8k

Log deprecations on a dedicated Monolog channel#36621

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

fabpot merged 1 commit intosymfony:masterfroml-vo:use_deprecations_channel

May 5, 2020

Merged

Log deprecations on a dedicated Monolog channel#36621

fabpot merged 1 commit intosymfony:masterfroml-vo:use_deprecations_channel

May 5, 2020

Conversation

Copy link

Contributor

l-vo commentedApr 29, 2020•
edited
Loading

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	https://github.com/orgs/symfony/projects/1#card-35233930
License	MIT
Doc PR	symfony/symfony-docs#13642

This PR allows to activate a specific channel for deprecations.

Base configuration

monolog:handlers:#...deprecation:type:streampath:"%kernel.logs_dir%/%kernel.environment%.deprecations.log"deprecation_filter:type:filterhandler:deprecationmax_level:infochannels:["php"]

Deprecation specific channel enabled:

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

carsonbot added Status: Needs Review Feature labels

Apr 29, 2020

l-vo force-pushed theuse_deprecations_channel branch froma62d9e2 to9867d58Compare

April 29, 2020 14:52

nicolas-grekas added this to thenext milestone

Apr 30, 2020

nicolas-grekas reviewed

Apr 30, 2020

View reviewed changes

Copy link

Member

nicolas-grekas left a comment

Choose a reason for hiding this comment

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

LGTM!

I'm wondering: is there a way to make the new channel a kind of alias for the "php" one, so that deprecations follow the same path as the php logs by default?

Note: if this PR is merged, it'll be possible to remove deprecation_filter Monolog handler in the Monolog bundle recipe.

yes! and we could move them to a NullLogger by default for the prod env

src/Symfony/Component/HttpKernel/CHANGELOG.md OutdatedShow resolvedHide resolved

l-vo force-pushed theuse_deprecations_channel branch from9867d58 to18200f8Compare

April 30, 2020 20:31

Copy link

ContributorAuthor

l-vo commentedApr 30, 2020

Do you mean to use the same handler(s) asphp channel if no handler if defined fordeprecation channel ?
Currently I don't see any way to do that but maybe we could add afallback (not sure for the name) tag property (with a channel name).FixEmptyLoggerPass could use the handlers defined for this channel instead ofNullHandler ?

Copy link

Member

nicolas-grekas commentedMay 4, 2020

Do you mean to use the same handler(s) as php channel if no handler if defined for deprecation channel ?

Yes, that's a possibility.

I fear that logging deprecations to a new channel might break apps that configured the php channel and expect deprecations to go there.

Ideally, we'd figure out a way to make the new channel opt-in somehow.

andrew-demb reviewed

May 4, 2020

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Resources/config/debug_prod.xmlShow resolvedHide resolved

Copy link

ContributorAuthor

l-vo commentedMay 4, 2020

Ideally, we'd figure out a way to make the new channel opt-in somehow.

Logging to specific channel is now disabled by default (the servicemonolog.logger.deprecation doesn't exist). Adding adeprecation additional channel in monolog configuration create the service and enable the feature (see exemple inPR description)