Add option to add Monolog channel to compiled log attributes

The channel is a relevant piece of metadata of a log entry.

This change adds an option to include the channel in the recorded attributes,
but remains backwards compatible and will not overwrite
existing extra or context fields named 'channel'.

Author: melkamar

src/Monolog/LogsHandler.php

@@ -31,18 +31,25 @@ class LogsHandler implements HandlerInterface
      */
     private $bubble;
 
+    /**
+     * Whether to include the channel name as an attribute in the Sentry logs.
+     */
+    private bool $includeChannel;
+
     /**
      * Creates a new Monolog handler that converts Monolog logs to Sentry logs.
      *
      * @psalm-suppress UndefinedDocblockClass
      *
-     * @param LogLevel|\Monolog\Level|int|null $logLevel the minimum logging level at which this handler will be triggered and collects the logs
-     * @param bool                             $bubble   whether the messages that are handled can bubble up the stack or not
+     * @param LogLevel|\Monolog\Level|int|null $logLevel       the minimum logging level at which this handler will be triggered and collects the logs
+     * @param bool                             $bubble         whether the messages that are handled can bubble up the stack or not
+     * @param bool                             $includeChannel whether to include the channel name as an attribute in the Sentry logs
      */
-    public function __construct($logLevel = null, bool $bubble = true)
+    public function __construct($logLevel = null, bool $bubble = true, bool $includeChannel = false)
     {
         $this->logLevel = $logLevel ?? LogLevel::debug();
         $this->bubble = $bubble;
+        $this->includeChannel = $includeChannel;
     }
 
     /**
@@ -144,6 +151,11 @@ public function __destruct()
      */
     protected function compileAttributes($record): array
     {
-        return array_merge($record['context'], $record['extra'], ['sentry.origin' => 'auto.log.monolog']);
+        return array_merge(
+            $this->includeChannel ? ['channel' => $record['channel']] : [],
+            $record['context'],
+            $record['extra'],
+            ['sentry.origin' => 'auto.log.monolog']
+        );
     }
 }

tests/Monolog/LogsHandlerTest.php

@@ -135,6 +135,29 @@ public function testOriginTagAppliedWithHandler(): void
         $this->assertSame('auto.log.monolog', $log->attributes()->toSimpleArray()['sentry.origin']);
     }
 
+    public function testChannelNotIncludedByDefault(): void
+    {
+        $handler = new LogsHandler();
+        $handler->handle(RecordFactory::create('without channel', Logger::WARNING, 'channel.foo', [], []));
+
+        $logs = Logs::getInstance()->aggregator()->all();
+        $this->assertCount(1, $logs);
+        $log = $logs[0];
+        $this->assertArrayNotHasKey('channel', $log->attributes()->toSimpleArray());
+    }
+
+    public function testChannelIncludedWhenEnabled(): void
+    {
+        $handler = new LogsHandler(LogLevel::warn(), true, true);
+        $handler->handle(RecordFactory::create('with channel', Logger::WARNING, 'channel.foo', [], []));
+
+        $logs = Logs::getInstance()->aggregator()->all();
+        $this->assertCount(1, $logs);
+        $log = $logs[0];
+        $this->assertArrayHasKey('channel', $log->attributes()->toSimpleArray());
+        $this->assertSame('channel.foo', $log->attributes()->toSimpleArray()['channel']);
+    }
+
     public function testOriginTagNotAppliedWhenUsingDirectly()
     {
         \Sentry\logger()->info('No origin attribute');