Prepend [Scout] to all log messages for Scout

src/Logger/FilteredLogLevelDecorator.php

@@ -17,6 +17,8 @@ final class FilteredLogLevelDecorator implements LoggerInterface
 {
     use LoggerTrait;
 
+    private const PREPEND_SCOUT_TAG = '[Scout] ';
+
     private const LOG_LEVEL_ORDER = [
         LogLevel::DEBUG => 0,
         LogLevel::INFO => 1,
@@ -52,6 +54,6 @@ public function log($level, $message, array $context = [])
             return;
         }
 
-        $this->realLogger->log($level, $message, $context);
+        $this->realLogger->log($level, self::PREPEND_SCOUT_TAG . $message, $context);
     }
 }

tests/Unit/AgentTest.php

@@ -41,7 +41,11 @@ public function testLogMessagesAreLoggedWhenUsingDefaultConfiguration() : void
 
         $logger->expects(self::once())
             ->method('log')
-            ->with(LogLevel::DEBUG, 'Scout Core Agent Connected', []);
+            ->with(
+                LogLevel::DEBUG,
+                self::stringContains('Scout Core Agent Connected'),
+                []
+            );
 
         $config = new Config();
         $config->set(ConfigKey::MONITORING_ENABLED, 'false');

tests/Unit/Logger/FilteredLogLevelDecoratorTest.php

@@ -16,6 +16,8 @@
 /** @covers \Scoutapm\Logger\FilteredLogLevelDecorator */
 final class FilteredLogLevelDecoratorTest extends TestCase
 {
+    private const PREPEND_SCOUT_TAG = '[Scout] ';
+
     /** @var LoggerInterface&MockObject */
     private $decoratedLogger;
 
@@ -26,6 +28,24 @@ public function setUp() : void
         $this->decoratedLogger = $this->createMock(LoggerInterface::class);
     }
 
+    public function testLogMessagesHaveScoutTagPrepended() : void
+    {
+        $decorator = new FilteredLogLevelDecorator($this->decoratedLogger, LogLevel::DEBUG);
+
+        $logMessage = uniqid('logMessage', true);
+
+        $this->decoratedLogger
+            ->expects(self::once())
+            ->method('log')
+            ->with(
+                LogLevel::DEBUG,
+                self::PREPEND_SCOUT_TAG . $logMessage,
+                []
+            );
+
+        $decorator->debug($logMessage);
+    }
+
     public function testLogMessagesBelowThresholdAreNotLogged() : void
     {
         $decorator = new FilteredLogLevelDecorator($this->decoratedLogger, LogLevel::NOTICE);
@@ -47,7 +67,11 @@ public function testLogMessagesAboveThresholdAreLogged() : void
         $this->decoratedLogger
             ->expects(self::once())
             ->method('log')
-            ->with(LogLevel::WARNING, $logMessage, $context);
+            ->with(
+                LogLevel::WARNING,
+                self::stringContains($logMessage),
+                $context
+            );
 
         $decorator->warning($logMessage, $context);
     }