[DI] Enhance logging in compiler passes #21396
Conversation
c1ee6c5 to
e38197c
Compare
|
It would be great to have a profiler panel that displays the contents of the var/cache/dev/appDevDebugProjectContainerCompiler.log file btw! |
a7f3d74 to
9f0545e
Compare
| @@ -95,6 +102,8 @@ public function addPass(CompilerPassInterface $pass, $type = PassConfig::TYPE_BE | |||
| */ | |||
| public function addLogMessage($string) | |||
| { | |||
| @trigger_error($string); | |||
There was a problem hiding this comment.
this will trigger them as E_USER_ERROR. IMO, it is too high. What about E_USER_NOTICE instead ? Lower than notice would be even better as this is a debugging info, but trigger_error does not have something lower (as it is not meant to be used as a debug logger)
btw, I'm not even convinced this is a good idea (at least not today as people will complain about silenced notices in the profiler)
There was a problem hiding this comment.
looking at the phdoc, the default is E_USER_NOTICE, so all good.
but I now made it explicit, and configurable (via a third "$level" arg)
There was a problem hiding this comment.
hum OK, I removed the trigger_error call for now - but kept the $level arg: even unused, it make the signature compatible with future changes requiring it.
|
The panel showing the container logs is a good idea though |
a0623c9 to
03be6dd
Compare
| $this->getCompiler()->log($pass, sprintf('Removed service "%s"; reason: %s.', $id, $reason)); | ||
| } | ||
|
|
||
| public function log(CompilerPassInterface $pass, $message, $level = E_USER_NOTICE) |
There was a problem hiding this comment.
I don't think passing a level here makes much sense, especially not as a PHP error level. It would couple it too much to the error triggering layer, while we talk about logging here.
If you want to provide a logging level, use PSR-3 levels instead.
Btw, a way to allow flexibility about adding a level only the day we need it is to make the method final: final method can add optional args as they want (adding an optional arg only breaks BC for inheritance)
There was a problem hiding this comment.
good idea, they are final now
70b9a6e to
21b8b34
Compare
21b8b34 to
fb200a0
Compare
|
"logRemoveService" removed |
|
Thank you @nicolas-grekas. |
This PR was merged into the 3.3-dev branch. Discussion ---------- [DI] Enhance logging in compiler passes | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - We should log more in compiler passes - and this should be better integrated in usual log reports. For logging more, let's drop LoggingFormatter and add a simple "log" method on ContainerBuilder. For better integration, let's throw silenced notices - they can be caught by our Debug handler. Commits ------- fb200a0 [DI] Enhance logging in compiler passes
We should log more in compiler passes - and this should be better integrated in usual log reports.
For logging more, let's drop LoggingFormatter and add a simple "log" method on ContainerBuilder.
For better integration, let's throw silenced notices - they can be caught by our Debug handler.