Log the bus name, receiver name and message class name when using Symfony Messenger (getsentry#492)

katchmk · ste93cry · web-flow · commit 070486efe5e2 · 2021-07-28T21:50:28.000+02:00
Co-authored-by: Stefano Arlandini &lt;sarlandini@alice.it&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Log the bus name, receiver name and message class name as event tags when using Symfony Messenger (#492)
 - Make the transport factory configurable in the bundle's config (#504)
 - Add the `sentry_trace_meta()` Twig function to print the `sentry-trace` HTML meta tag (#510)
 - Make the list of commands for which distributed tracing is active configurable (#515)
diff --git a/src/EventListener/MessengerListener.php b/src/EventListener/MessengerListener.php
@@ -4,10 +4,13 @@
 
 namespace Sentry\SentryBundle\EventListener;
 
+use Sentry\Event;
 use Sentry\State\HubInterface;
+use Sentry\State\Scope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
+use Symfony\Component\Messenger\Stamp\BusNameStamp;
 
 final class MessengerListener
 {
@@ -45,15 +48,28 @@ public function handleWorkerMessageFailedEvent(WorkerMessageFailedEvent $event):
             return;
         }
 
-        $error = $event->getThrowable();
+        $this->hub->withScope(function (Scope $scope) use ($event): void {
+            $envelope = $event->getEnvelope();
+            $exception = $event->getThrowable();
 
-        if ($error instanceof HandlerFailedException) {
-            foreach ($error->getNestedExceptions() as $nestedException) {
-                $this->hub->captureException($nestedException);
+            $scope->setTag('messenger.receiver_name', $event->getReceiverName());
+            $scope->setTag('messenger.message_class', \get_class($envelope->getMessage()));
+
+            /** @var BusNameStamp|null $messageBusStamp */
+            $messageBusStamp = $envelope->last(BusNameStamp::class);
+
+            if (null !== $messageBusStamp) {
+                $scope->setTag('messenger.message_bus', $messageBusStamp->getBusName());
             }
-        } else {
-            $this->hub->captureException($error);
-        }
+
+            if ($exception instanceof HandlerFailedException) {
+                foreach ($exception->getNestedExceptions() as $nestedException) {
+                    $this->hub->captureException($nestedException);
+                }
+            } else {
+                $this->hub->captureException($exception);
+            }
+        });
 
         $this->flushClient();
     }
diff --git a/tests/EventListener/MessengerListenerTest.php b/tests/EventListener/MessengerListenerTest.php
@@ -7,14 +7,17 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Sentry\ClientInterface;
+use Sentry\Event;
 use Sentry\SentryBundle\EventListener\MessengerListener;
 use Sentry\SentryBundle\Tests\End2End\App\Kernel;
 use Sentry\State\HubInterface;
+use Sentry\State\Scope;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Stamp\BusNameStamp;
 
 final class MessengerListenerTest extends TestCase
 {
@@ -37,14 +40,23 @@ protected function setUp(): void
     /**
      * @dataProvider handleWorkerMessageFailedEventDataProvider
      *
-     * @param \Throwable[] $exceptions
+     * @param \Throwable[]          $exceptions
+     * @param array<string, string> $expectedTags
      */
-    public function testHandleWorkerMessageFailedEvent(array $exceptions, WorkerMessageFailedEvent $event): void
+    public function testHandleWorkerMessageFailedEvent(array $exceptions, WorkerMessageFailedEvent $event, array $expectedTags): void
     {
         if (!$this->supportsMessenger()) {
             $this->markTestSkipped('Messenger not supported in this environment.');
         }
 
+        $scope = new Scope();
+
+        $this->hub->expects($this->once())
+            ->method('withScope')
+            ->willReturnCallback(function (callable $callback) use ($scope): void {
+                $callback($scope);
+            });
+
         $this->hub->expects($this->exactly(\count($exceptions)))
             ->method('captureException')
             ->withConsecutive(...array_map(static function (\Throwable $exception): array {
@@ -57,6 +69,10 @@ public function testHandleWorkerMessageFailedEvent(array $exceptions, WorkerMess
 
         $listener = new MessengerListener($this->hub);
         $listener->handleWorkerMessageFailedEvent($event);
+
+        $sentryEvent = $scope->applyToEvent(Event::createEvent());
+
+        $this->assertSame($expectedTags, $sentryEvent->getTags());
     }
 
     /**
@@ -74,18 +90,34 @@ public function handleWorkerMessageFailedEventDataProvider(): \Generator
             new \Exception(),
         ];
 
-        yield [
+        yield 'envelope.throwable INSTANCEOF HandlerFailedException' => [
             $exceptions,
             $this->getMessageFailedEvent($envelope, 'receiver', new HandlerFailedException($envelope, $exceptions), false),
+            [
+                'messenger.receiver_name' => 'receiver',
+                'messenger.message_class' => \get_class($envelope->getMessage()),
+            ],
         ];
 
-        $exceptions = [
-            new \Exception(),
+        yield 'envelope.throwable INSTANCEOF Exception' => [
+            [$exceptions[0]],
+            $this->getMessageFailedEvent($envelope, 'receiver', $exceptions[0], false),
+            [
+                'messenger.receiver_name' => 'receiver',
+                'messenger.message_class' => \get_class($envelope->getMessage()),
+            ],
         ];
 
-        yield [
-            $exceptions,
+        $envelope = new Envelope((object) [], [new BusNameStamp('bus.foo')]);
+
+        yield 'envelope.stamps CONTAINS BusNameStamp' => [
+            [$exceptions[0]],
             $this->getMessageFailedEvent($envelope, 'receiver', $exceptions[0], false),
+            [
+                'messenger.receiver_name' => 'receiver',
+                'messenger.message_class' => \get_class($envelope->getMessage()),
+                'messenger.message_bus' => 'bus.foo',
+            ],
         ];
     }
 
