[10.x] Add processors to logging (placeholders) (#46344)

* add processors to logging (placeholders) * formatting * fix tests --------- Co-authored-by: Taylor Otwell <taylor@laravel.com>
laravel · Mar 6, 2023 · e792f4c · e792f4c
1 parent df0135b
commit e792f4c
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 8 deletions.
diff --git a/src/Illuminate/Log/LogManager.php b/src/Illuminate/Log/LogManager.php
@@ -16,6 +16,8 @@
 use Monolog\Handler\SyslogHandler;
 use Monolog\Handler\WhatFailureGroupHandler;
 use Monolog\Logger as Monolog;
+use Monolog\Processor\ProcessorInterface;
+use Monolog\Processor\PsrLogMessageProcessor;
 use Psr\Log\LoggerInterface;
 use Throwable;
 
@@ -293,7 +295,7 @@ protected function createSingleDriver(array $config)
                     $config['bubble'] ?? true, $config['permission'] ?? null, $config['locking'] ?? false
                 ), $config
             ),
-        ]);
+        ], $config['replace_placeholders'] ?? false ? [new PsrLogMessageProcessor()] : []);
     }
 
     /**
@@ -309,7 +311,7 @@ protected function createDailyDriver(array $config)
                 $config['path'], $config['days'] ?? 7, $this->level($config),
                 $config['bubble'] ?? true, $config['permission'] ?? null, $config['locking'] ?? false
             ), $config),
-        ]);
+        ], $config['replace_placeholders'] ?? false ? [new PsrLogMessageProcessor()] : []);
     }
 
     /**
@@ -333,7 +335,7 @@ protected function createSlackDriver(array $config)
                 $config['bubble'] ?? true,
                 $config['exclude_fields'] ?? []
             ), $config),
-        ]);
+        ], $config['replace_placeholders'] ?? false ? [new PsrLogMessageProcessor()] : []);
     }
 
     /**
@@ -349,7 +351,7 @@ protected function createSyslogDriver(array $config)
                 Str::snake($this->app['config']['app.name'], '-'),
                 $config['facility'] ?? LOG_USER, $this->level($config)
             ), $config),
-        ]);
+        ], $config['replace_placeholders'] ?? false ? [new PsrLogMessageProcessor()] : []);
     }
 
     /**
@@ -364,7 +366,7 @@ protected function createErrorlogDriver(array $config)
             $this->prepareHandler(new ErrorLogHandler(
                 $config['type'] ?? ErrorLogHandler::OPERATING_SYSTEM, $this->level($config)
             )),
-        ]);
+        ], $config['replace_placeholders'] ?? false ? [new PsrLogMessageProcessor()] : []);
     }
 
     /**
@@ -384,15 +386,33 @@ protected function createMonologDriver(array $config)
             );
         }
 
+        collect($config['processors'] ?? [])->each(function ($processor) {
+            $processor = $processor['processor'] ?? $processor;
+
+            if (! is_a($processor, ProcessorInterface::class, true)) {
+                throw new InvalidArgumentException(
+                    $processor.' must be an instance of '.ProcessorInterface::class
+                );
+            }
+        });
+
         $with = array_merge(
             ['level' => $this->level($config)],
             $config['with'] ?? [],
             $config['handler_with'] ?? []
         );
 
-        return new Monolog($this->parseChannel($config), [$this->prepareHandler(
-            $this->app->make($config['handler'], $with), $config
-        )]);
+        return new Monolog(
+            $this->parseChannel($config),
+            [
+                $this->prepareHandler(
+                    $this->app->make($config['handler'], $with), $config
+                )
+            ],
+            collect($config['processors'] ?? [])
+                ->map(fn ($processor) =>
+                    $this->app->make($processor['processor'] ?? $processor, $processor['with'] ?? [])
+        )->toArray());
     }
 
     /**

diff --git a/tests/Log/LogManagerTest.php b/tests/Log/LogManagerTest.php
@@ -15,6 +15,8 @@
 use Monolog\Handler\SyslogHandler;
 use Monolog\Level;
 use Monolog\Logger as Monolog;
+use Monolog\Processor\MemoryUsageProcessor;
+use Monolog\Processor\PsrLogMessageProcessor;
 use Monolog\Processor\UidProcessor;
 use Orchestra\Testbench\TestCase;
 use ReflectionProperty;
@@ -63,6 +65,7 @@ public function testStackChannel()
                 'stream' => 'php://stderr',
                 'bubble' => false,
             ],
+            'processors' => [PsrLogMessageProcessor::class],
         ]);
 
         $config->set('logging.channels.stdout', [
@@ -84,6 +87,7 @@ public function testStackChannel()
         $this->assertInstanceOf(Logger::class, $logger);
         $this->assertCount(2, $handlers);
         $this->assertInstanceOf(StreamHandler::class, $handlers[0]);
+        $this->assertInstanceOf(PsrLogMessageProcessor::class, $logger->getLogger()->getProcessors()[0]);
         $this->assertInstanceOf(StreamHandler::class, $handlers[1]);
         $this->assertEquals(Level::Notice, $handlers[0]->getLevel());
         $this->assertEquals(Level::Info, $handlers[1]->getLevel());
@@ -211,6 +215,39 @@ public function testLogManagerCreatesMonologHandlerWithProperFormatter()
         $this->assertInstanceOf(NullHandler::class, $handler);
     }
 
+    public function testLogManagerCreatesMonologHandlerWithProcessors()
+    {
+        $config = $this->app->make('config');
+        $config->set('logging.channels.memory', [
+            'driver' => 'monolog',
+            'name' => 'memory',
+            'handler' => StreamHandler::class,
+            'with' => [
+                'stream' => 'php://stderr',
+            ],
+            'processors' => [
+                MemoryUsageProcessor::class,
+                ['processor' => PsrLogMessageProcessor::class, 'with' => ['removeUsedContextFields' => true]],
+            ],
+        ]);
+
+        $manager = new LogManager($this->app);
+
+        // create logger with handler specified from configuration
+        $logger = $manager->channel('memory');
+        $handler = $logger->getLogger()->getHandlers()[0];
+        $processors = $logger->getLogger()->getProcessors();
+
+        $this->assertInstanceOf(StreamHandler::class, $handler);
+        $this->assertInstanceOf(MemoryUsageProcessor::class, $processors[0]);
+        $this->assertInstanceOf(PsrLogMessageProcessor::class, $processors[1]);
+
+        $removeUsedContextFields = new ReflectionProperty(get_class($processors[1]), 'removeUsedContextFields');
+        $removeUsedContextFields->setAccessible(true);
+
+        $this->assertTrue($removeUsedContextFields->getValue($processors[1]));
+    }
+
     public function testItUtilisesTheNullDriverDuringTestsWhenNullDriverUsed()
     {
         $config = $this->app->make('config');
@@ -253,6 +290,7 @@ public function testLogManagerCreateSingleDriverWithConfiguredFormatter()
             'driver' => 'single',
             'name' => 'ds',
             'path' => storage_path('logs/laravel.log'),
+            'replace_placeholders' => true,
         ]);
 
         $manager = new LogManager($this->app);
@@ -264,6 +302,7 @@ public function testLogManagerCreateSingleDriverWithConfiguredFormatter()
 
         $this->assertInstanceOf(StreamHandler::class, $handler);
         $this->assertInstanceOf(LineFormatter::class, $formatter);
+        $this->assertInstanceOf(PsrLogMessageProcessor::class, $logger->getLogger()->getProcessors()[0]);
 
         $config->set('logging.channels.formattedsingle', [
             'driver' => 'single',
@@ -273,6 +312,7 @@ public function testLogManagerCreateSingleDriverWithConfiguredFormatter()
             'formatter_with' => [
                 'dateFormat' => 'Y/m/d--test',
             ],
+            'replace_placeholders' => false,
         ]);
 
         $logger = $manager->channel('formattedsingle');
@@ -281,6 +321,7 @@ public function testLogManagerCreateSingleDriverWithConfiguredFormatter()
 
         $this->assertInstanceOf(StreamHandler::class, $handler);
         $this->assertInstanceOf(HtmlFormatter::class, $formatter);
+        $this->assertEmpty($logger->getLogger()->getProcessors());
 
         $dateFormat = new ReflectionProperty(get_class($formatter), 'dateFormat');
         $dateFormat->setAccessible(true);
@@ -295,6 +336,7 @@ public function testLogManagerCreateDailyDriverWithConfiguredFormatter()
             'driver' => 'daily',
             'name' => 'dd',
             'path' => storage_path('logs/laravel.log'),
+            'replace_placeholders' => true,
         ]);
 
         $manager = new LogManager($this->app);
@@ -306,6 +348,7 @@ public function testLogManagerCreateDailyDriverWithConfiguredFormatter()
 
         $this->assertInstanceOf(StreamHandler::class, $handler);
         $this->assertInstanceOf(LineFormatter::class, $formatter);
+        $this->assertInstanceOf(PsrLogMessageProcessor::class, $logger->getLogger()->getProcessors()[0]);
 
         $config->set('logging.channels.formatteddaily', [
             'driver' => 'daily',
@@ -315,6 +358,7 @@ public function testLogManagerCreateDailyDriverWithConfiguredFormatter()
             'formatter_with' => [
                 'dateFormat' => 'Y/m/d--test',
             ],
+            'replace_placeholders' => false,
         ]);
 
         $logger = $manager->channel('formatteddaily');
@@ -323,6 +367,7 @@ public function testLogManagerCreateDailyDriverWithConfiguredFormatter()
 
         $this->assertInstanceOf(StreamHandler::class, $handler);
         $this->assertInstanceOf(HtmlFormatter::class, $formatter);
+        $this->assertEmpty($logger->getLogger()->getProcessors());
 
         $dateFormat = new ReflectionProperty(get_class($formatter), 'dateFormat');
         $dateFormat->setAccessible(true);
@@ -336,6 +381,7 @@ public function testLogManagerCreateSyslogDriverWithConfiguredFormatter()
         $config->set('logging.channels.defaultsyslog', [
             'driver' => 'syslog',
             'name' => 'ds',
+            'replace_placeholders' => true,
         ]);
 
         $manager = new LogManager($this->app);
@@ -347,6 +393,7 @@ public function testLogManagerCreateSyslogDriverWithConfiguredFormatter()
 
         $this->assertInstanceOf(SyslogHandler::class, $handler);
         $this->assertInstanceOf(LineFormatter::class, $formatter);
+        $this->assertInstanceOf(PsrLogMessageProcessor::class, $logger->getLogger()->getProcessors()[0]);
 
         $config->set('logging.channels.formattedsyslog', [
             'driver' => 'syslog',
@@ -355,6 +402,7 @@ public function testLogManagerCreateSyslogDriverWithConfiguredFormatter()
             'formatter_with' => [
                 'dateFormat' => 'Y/m/d--test',
             ],
+            'replace_placeholders' => false,
         ]);
 
         $logger = $manager->channel('formattedsyslog');
@@ -363,6 +411,7 @@ public function testLogManagerCreateSyslogDriverWithConfiguredFormatter()
 
         $this->assertInstanceOf(SyslogHandler::class, $handler);
         $this->assertInstanceOf(HtmlFormatter::class, $formatter);
+        $this->assertEmpty($logger->getLogger()->getProcessors());
 
         $dateFormat = new ReflectionProperty(get_class($formatter), 'dateFormat');
         $dateFormat->setAccessible(true);