[FrameworkBundle][HttpKernel] Allow configuring the logging channel per type of exceptions

Author: Arkalo2

CHANGELOG.md

@@ -7,7 +7,8 @@ CHANGELOG
  * Add `$key` argument to `#[MapQueryString]` that allows using a specific key for argument resolving
  * Support `Uid` in `#[MapQueryParameter]`
  * Add `ServicesResetterInterface`, implemented by `ServicesResetter`
-
+ * Allow configuring the logging channel per type of exceptions in ErrorListener
+ 
 7.2
 ---
 

EventListener/ErrorListener.php

@@ -34,20 +34,22 @@
 class ErrorListener implements EventSubscriberInterface
 {
     /**
-     * @param array<class-string, array{log_level: string|null, status_code: int<100,599>|null}> $exceptionsMapping
+     * @param array<class-string, array{log_level: string|null, status_code: int<100,599>|null, log_channel: string|null}> $exceptionsMapping
      */
     public function __construct(
         protected string|object|array|null $controller,
         protected ?LoggerInterface $logger = null,
         protected bool $debug = false,
         protected array $exceptionsMapping = [],
+        protected array $loggers = [],
     ) {
     }
 
     public function logKernelException(ExceptionEvent $event): void
     {
         $throwable = $event->getThrowable();
         $logLevel = $this->resolveLogLevel($throwable);
+        $logChannel = $this->resolveLogChannel($throwable);
 
         foreach ($this->exceptionsMapping as $class => $config) {
             if (!$throwable instanceof $class || !$config['status_code']) {
@@ -69,7 +71,7 @@ public function logKernelException(ExceptionEvent $event): void
 
         $e = FlattenException::createFromThrowable($throwable);
 
-        $this->logException($throwable, \sprintf('Uncaught PHP Exception %s: "%s" at %s line %s', $e->getClass(), $e->getMessage(), basename($e->getFile()), $e->getLine()), $logLevel);
+        $this->logException($throwable, \sprintf('Uncaught PHP Exception %s: "%s" at %s line %s', $e->getClass(), $e->getMessage(), basename($e->getFile()), $e->getLine()), $logLevel, $logChannel);
     }
 
     public function onKernelException(ExceptionEvent $event): void
@@ -159,16 +161,20 @@ public static function getSubscribedEvents(): array
 
     /**
      * Logs an exception.
+     * 
+     * @param ?string $logChannel
      */
-    protected function logException(\Throwable $exception, string $message, ?string $logLevel = null): void
+    protected function logException(\Throwable $exception, string $message, ?string $logLevel = null, /* ?string $logChannel = null */): void
     {
-        if (null === $this->logger) {
+        $logChannel = (3 < \func_num_args() ? \func_get_arg(3) : null) ?? $this->resolveLogChannel($exception);
+        
+        $logLevel ??= $this->resolveLogLevel($exception);
+        
+        if(!$logger = $this->getLogger($logChannel)) {
             return;
         }
 
-        $logLevel ??= $this->resolveLogLevel($exception);
-
-        $this->logger->log($logLevel, $message, ['exception' => $exception]);
+        $logger->log($logLevel, $message, ['exception' => $exception]);
     }
 
     /**
@@ -193,6 +199,17 @@ private function resolveLogLevel(\Throwable $throwable): string
         return LogLevel::ERROR;
     }
 
+    private function resolveLogChannel(\Throwable $throwable): ?string
+    {
+        foreach ($this->exceptionsMapping as $class => $config) {
+            if ($throwable instanceof $class && isset($config['log_channel'])) {
+                return $config['log_channel'];
+            }
+        }
+
+        return null;
+    }
+
     /**
      * Clones the request for the exception.
      */
@@ -201,7 +218,7 @@ protected function duplicateRequest(\Throwable $exception, Request $request): Re
         $attributes = [
             '_controller' => $this->controller,
             'exception' => $exception,
-            'logger' => DebugLoggerConfigurator::getDebugLogger($this->logger),
+            'logger' => DebugLoggerConfigurator::getDebugLogger($this->getLogger($exception)),
         ];
         $request = $request->duplicate(null, null, $attributes);
         $request->setMethod('GET');
@@ -249,4 +266,9 @@ private function getInheritedAttribute(string $class, string $attribute): ?objec
 
         return $attributeReflector?->newInstance();
     }
+
+    private function getLogger(?string $logChannel): ?LoggerInterface
+    {
+        return $logChannel ? $this->loggers[$logChannel] ?? $this->logger : $this->logger;
+    }
 }

Tests/EventListener/ErrorListenerTest.php

@@ -143,6 +143,63 @@ public function testHandleWithLogLevelAttribute()
         $this->assertCount(1, $logger->getLogsForLevel('warning'));
     }
 
+    public function testHandleWithLogChannel()
+    {
+        $request = new Request();
+        $event = new ExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MAIN_REQUEST, new \RuntimeException('bar'));
+
+        $defaultLogger = new TestLogger();
+        $channelLoger = new TestLogger();
+
+        $l = new ErrorListener('not used', $defaultLogger, false, [
+            \RuntimeException::class => [
+                'log_level' => 'warning',
+                'status_code' => 401,
+                'log_channel' => 'channel',
+            ],
+            \Exception::class => [
+                'log_level' => 'error',
+                'status_code' => 402,
+            ],
+        ], ['channel' => $channelLoger]);
+
+        $l->logKernelException($event);
+        $l->onKernelException($event);
+
+        $this->assertCount(0, $defaultLogger->getLogsForLevel('error'));
+        $this->assertCount(0, $defaultLogger->getLogsForLevel('warning'));
+        $this->assertCount(0, $channelLoger->getLogsForLevel('error'));
+        $this->assertCount(1, $channelLoger->getLogsForLevel('warning'));
+    }
+
+    public function testHandleWithLoggerChannelNotUsed()
+    {
+        $request = new Request();
+        $event = new ExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MAIN_REQUEST, new \RuntimeException('bar'));
+        $defaultLogger = new TestLogger();
+        $channelLoger = new TestLogger();
+        $l = new ErrorListener('not used', $defaultLogger, false, [
+            \RuntimeException::class => [
+                'log_level' => 'warning',
+                'status_code' => 401,
+            ],
+            \ErrorException::class => [
+                'log_level' => 'error',
+                'status_code' => 402,
+                'log_channel' => 'channel',
+            ],
+        ], ['channel' => $channelLoger]);
+        $l->logKernelException($event);
+        $l->onKernelException($event);
+
+        $this->assertSame(0, $defaultLogger->countErrors());
+        $this->assertCount(0, $defaultLogger->getLogsForLevel('critical'));
+        $this->assertCount(1, $defaultLogger->getLogsForLevel('warning'));
+        $this->assertCount(0, $channelLoger->getLogsForLevel('warning'));
+        $this->assertCount(0, $channelLoger->getLogsForLevel('error'));
+        $this->assertCount(0, $channelLoger->getLogsForLevel('critical'));
+    }
+
     public function testHandleClassImplementingInterfaceWithLogLevelAttribute()
     {
         $request = new Request();