Add doctrine dbal tracing support that is optional to enable

Author: rjd22

src/DependencyInjection/Compiler/ConnectDbalQueryListenerPass.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\DependencyInjection\Compiler;
+
+use Sentry\SentryBundle\EventListener\Tracing\DbalListener;
+use Sentry\State\HubInterface;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+class ConnectDbalQueryListenerPass implements CompilerPassInterface
+{
+    /**
+     * @return void
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $config = $container->getExtensionConfig('sentry');
+
+        $registerDbalListener = isset($config[0]['register_dbal_listener'])
+            ? $config[0]['register_dbal_listener']
+            : false;
+
+        if ($registerDbalListener && $container->hasDefinition('doctrine.dbal.logger')) {
+            $container->setDefinition(
+                'doctrine.dbal.logger',
+                new Definition(DbalListener::class, [$container->getDefinition(HubInterface::class)])
+            );
+        }
+    }
+}

src/DependencyInjection/Configuration.php

@@ -37,6 +37,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->end()
                 ->end()
                 ->booleanNode('register_error_listener')->defaultTrue()->end()
+                ->booleanNode('register_dbal_listener')->defaultFalse()->end()
                 ->arrayNode('options')
                     ->addDefaultsIfNotSet()
                     ->fixXmlConfig('integration')

src/EventListener/Tracing/DbalListener.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\EventListener\Tracing;
+
+use Doctrine\DBAL\Logging\SQLLogger;
+use Sentry\State\HubInterface;
+use Sentry\Tracing\Span;
+use Sentry\Tracing\SpanContext;
+
+/**
+ * Getting the logger, tied into dbal seems extremely hard. Cheating the system a bit by putting it in between the
+ * debug stack logger.
+ */
+final class DbalListener implements SQLLogger
+{
+    /**
+     * @var HubInterface The current hub
+     */
+    private $hub;
+
+    /**
+     * @var Span
+     */
+    private $querySpan;
+
+    /**
+     * @param HubInterface $hub The current hub
+     */
+    public function __construct(HubInterface $hub)
+    {
+        $this->hub = $hub;
+    }
+
+    /**
+     * @param string $sql
+     */
+    public function startQuery($sql, ?array $params = null, ?array $types = null)
+    {
+        $transaction = $this->hub->getTransaction();
+
+        if (!$transaction) {
+            return;
+        }
+
+        $spanContext = new SpanContext();
+        $spanContext->setOp('doctrine.query');
+        $spanContext->setDescription($sql);
+
+        $this->querySpan = $transaction->startChild($spanContext);
+    }
+
+    public function stopQuery()
+    {
+        if (!$this->querySpan instanceof Span) {
+            return;
+        }
+
+        $this->querySpan->finish();
+    }
+}

src/SentryBundle.php

@@ -4,9 +4,18 @@
 
 namespace Sentry\SentryBundle;
 
+use Sentry\SentryBundle\DependencyInjection\Compiler\ConnectDbalQueryListenerPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 final class SentryBundle extends Bundle
 {
     public const SDK_IDENTIFIER = 'sentry.php.symfony';
+
+    public function build(ContainerBuilder $container): void
+    {
+        parent::build($container);
+
+        $container->addCompilerPass(new ConnectDbalQueryListenerPass());
+    }
 }

src/aliases.php

@@ -5,13 +5,17 @@
 use Sentry\SentryBundle\EventListener\ErrorListenerExceptionEvent;
 use Sentry\SentryBundle\EventListener\RequestListenerControllerEvent;
 use Sentry\SentryBundle\EventListener\RequestListenerRequestEvent;
+use Sentry\SentryBundle\EventListener\RequestListenerResponseEvent;
+use Sentry\SentryBundle\EventListener\RequestListenerTerminateEvent;
 use Sentry\SentryBundle\EventListener\SubRequestListenerRequestEvent;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
 use Symfony\Component\HttpKernel\Kernel;
 
 if (version_compare(Kernel::VERSION, '4.3.0', '>=')) {
@@ -30,6 +34,16 @@ class_alias(RequestEvent::class, RequestListenerRequestEvent::class);
         class_alias(ControllerEvent::class, RequestListenerControllerEvent::class);
     }
 
+    if (!class_exists(RequestListenerResponseEvent::class, false)) {
+        /** @psalm-suppress UndefinedClass */
+        class_alias(ResponseEvent::class, RequestListenerResponseEvent::class);
+    }
+
+    if (!class_exists(RequestListenerTerminateEvent::class, false)) {
+        /** @psalm-suppress UndefinedClass */
+        class_alias(TerminateEvent::class, RequestListenerTerminateEvent::class);
+    }
+
     if (!class_exists(SubRequestListenerRequestEvent::class, false)) {
         /** @psalm-suppress UndefinedClass */
         class_alias(RequestEvent::class, SubRequestListenerRequestEvent::class);