bug #173 ability to configure whether messages should be formatted as PSR-3 (ged15)

This PR was submitted for the master branch but it was merged into the 2.x branch instead (closes #173).

Discussion
----------

ability to configure whether messages should be formatted as PSR-3

This PR symfony/symfony#17166 (reasons described in symfony/symfony#15753) has changed the way messages are logged in Symfony. Now log messages contain placeholders (see https://github.com/symfony/symfony-standard/issues/981).
While this could be a useful feature, IMO by default in SE messages should be preformatted.
This PR introduces a new optional config option that makes the messages be preformatted by default but this behaviour can also be disabled.

Commits
-------

6c8a44b ability to configure whether messages should be formatted as PSR-3
44f3daf minor #179 removed obsolete code (fabpot)
7d28c5a Merge branch '2.x'
b6baaaf Merge branch '2.x'
57b33d6 removed obsolete code
a45682c updated CHANGELOG
bcbf4c5 fixed tests
079c3d1 feature #170 remove class parameters (avant1)
6398efc remove class parameters
885da32 added a CHANGELOG
d8b3f8a feature #169 Deprecate the NotFoundActivationStrategy class (BPScott)
b77bdf0 Deprecate the NotFoundActivationStrategy class
ce169ee bumped version to 3.x

Author: fabpot

DependencyInjection/Configuration.php

@@ -311,6 +311,7 @@ public function getConfigTreeBuilder()
                             ->booleanNode('bubble')->defaultTrue()->end()
                             ->scalarNode('app_name')->defaultNull()->end()
                             ->booleanNode('include_stacktraces')->defaultFalse()->end()
+                            ->booleanNode('process_psr_3_messages')->defaultTrue()->end()
                             ->scalarNode('path')->defaultValue('%kernel.logs_dir%/%kernel.environment%.log')->end() // stream and rotating
                             ->scalarNode('file_permission')  // stream and rotating
                                 ->defaultNull()

DependencyInjection/MonologExtension.php

@@ -136,6 +136,17 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
             $definition->setConfigurator(array('Symfony\\Bundle\\MonologBundle\\MonologBundle', 'includeStacktraces'));
         }
 
+        if ($handler['process_psr_3_messages']) {
+            $processorId = 'monolog.processor.psr_log_message';
+            if (!$container->hasDefinition($processorId)) {
+                $processor = new Definition('Monolog\\Processor\\PsrLogMessageProcessor');
+                $processor->setPublic(false);
+                $container->setDefinition($processorId, $processor);
+            }
+
+            $definition->addMethodCall('pushProcessor', array(new Reference($processorId)));
+        }
+
         switch ($handler['type']) {
         case 'service':
             $container->setAlias($handlerId, $handler['id']);

Resources/config/schema/monolog-1.0.xsd

@@ -32,6 +32,7 @@
         <xsd:attribute name="priority" type="xsd:integer" />
         <xsd:attribute name="level" type="level" />
         <xsd:attribute name="bubble" type="xsd:boolean" />
+        <xsd:attribute name="process-psr-3-messages" type="xsd:boolean" />
         <xsd:attribute name="app-name" type="xsd:string" />
         <xsd:attribute name="path" type="xsd:string" />
         <xsd:attribute name="id" type="xsd:string" />

Tests/DependencyInjection/FixtureMonologExtensionTest.php

@@ -14,6 +14,7 @@
 use Symfony\Bundle\MonologBundle\DependencyInjection\MonologExtension;
 use Symfony\Bundle\MonologBundle\DependencyInjection\Compiler\LoggerChannelPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
 abstract class FixtureMonologExtensionTest extends DependencyInjectionTest
@@ -178,6 +179,22 @@ public function testChannelParametersResolved()
         );
     }
 
+    public function testPsr3MessageProcessingDisabled()
+    {
+        $container = $this->getContainer('process_psr_3_messages_disabled');
+
+        $logger = $container->getDefinition('monolog.handler.custom');
+
+        $methodCalls = $logger->getMethodCalls();
+
+        foreach ($methodCalls as $methodCall) {
+            list($methodName, $params) = $methodCall;
+            if ($methodName === 'pushProcessor') {
+                $this->assertNotEquals(array(new Definition('monolog.processor.psr_log_message')), $params);
+            }
+        }
+    }
+
     protected function getContainer($fixture)
     {
         $container = new ContainerBuilder();

Tests/DependencyInjection/Fixtures/xml/process_psr_3_messages_disabled.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" ?>
+
+<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"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/monolog http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">
+    <monolog:config>
+        <monolog:handler name="custom" type="stream" path="/tmp/symfony.log" process-psr-3-messages="false"/>
+    </monolog:config>
+</container>

Tests/DependencyInjection/Fixtures/yml/process_psr_3_messages_disabled.yml

@@ -0,0 +1,6 @@
+monolog:
+    handlers:
+        custom:
+            type: stream
+            path: /tmp/symfony.log
+            process_psr_3_messages: false

Tests/DependencyInjection/MonologExtensionTest.php

@@ -33,6 +33,7 @@ public function testLoadWithDefault()
         $handler = $container->getDefinition('monolog.handler.main');
         $this->assertDICDefinitionClass($handler, '%monolog.handler.stream.class%');
         $this->assertDICConstructorArguments($handler, array('%kernel.logs_dir%/%kernel.environment%.log', \Monolog\Logger::DEBUG, true, null));
+        $this->assertDICDefinitionMethodCallAt(0, $handler, 'pushProcessor', array(new Reference('monolog.processor.psr_log_message')));
     }
 
     public function testLoadWithCustomValues()
@@ -232,10 +233,10 @@ public function testSocketHandler()
         $handler = $container->getDefinition('monolog.handler.socket');
         $this->assertDICDefinitionClass($handler, '%monolog.handler.socket.class%');
         $this->assertDICConstructorArguments($handler, array('localhost:50505', \Monolog\Logger::DEBUG, true));
-        $this->assertDICDefinitionMethodCallAt(0, $handler, 'setTimeout', array('1'));
-        $this->assertDICDefinitionMethodCallAt(1, $handler, 'setConnectionTimeout', array('0.6'));
-        $this->assertDICDefinitionMethodCallAt(2, $handler, 'setPersistent', array(true));
-
+        $this->assertDICDefinitionMethodCallAt(0, $handler, 'pushProcessor', array(new Reference('monolog.processor.psr_log_message')));
+        $this->assertDICDefinitionMethodCallAt(1, $handler, 'setTimeout', array('1'));
+        $this->assertDICDefinitionMethodCallAt(2, $handler, 'setConnectionTimeout', array('0.6'));
+        $this->assertDICDefinitionMethodCallAt(3, $handler, 'setPersistent', array(true));
     }
 
     public function testRavenHandlerWhenConfigurationIsWrong()
@@ -331,14 +332,14 @@ public function testLogglyHandler()
         $handler = $container->getDefinition('monolog.handler.loggly');
         $this->assertDICDefinitionClass($handler, '%monolog.handler.loggly.class%');
         $this->assertDICConstructorArguments($handler, array($token, \Monolog\Logger::DEBUG, true));
-        $this->assertEmpty($handler->getMethodCalls());
+        $this->assertDICDefinitionMethodCallAt(0, $handler, 'pushProcessor', array(new Reference('monolog.processor.psr_log_message')));
 
         $container = $this->getContainer(array(array('handlers' => array('loggly' => array(
             'type' => 'loggly', 'token' => $token, 'tags' => array(' ', 'foo', '', 'bar'))
         ))));
         $handler = $container->getDefinition('monolog.handler.loggly');
-        $this->assertDICDefinitionMethodCallAt(0, $handler, 'setTag', array('foo,bar'));
-
+        $this->assertDICDefinitionMethodCallAt(0, $handler, 'pushProcessor', array(new Reference('monolog.processor.psr_log_message')));
+        $this->assertDICDefinitionMethodCallAt(1, $handler, 'setTag', array('foo,bar'));
     }
 
     protected function getContainer(array $config = array())