feat(DependencyInjection): do not instrument services if packages are…

… missing
FriendsOfOpenTelemetry · Jan 13, 2025 · 0601912 · 0601912
1 parent f247c61
commit 0601912
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 8 deletions.
diff --git a/src/DependencyInjection/Compiler/CacheInstrumentationPass.php b/src/DependencyInjection/Compiler/CacheInstrumentationPass.php
@@ -2,6 +2,7 @@
 
 namespace FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler;
 
+use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -20,6 +21,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
+        if (!class_exists(CacheItem::class)) {
+            throw new \LogicException('Cache instrumentation cannot be enabled because the symfony/cache package is not installed.');
+        }
+
         foreach ($container->findTaggedServiceIds('cache.pool') as $serviceId => $tags) {
             $cachePoolDefinition = $container->getDefinition($serviceId);
             if ($cachePoolDefinition->isAbstract()) {

diff --git a/src/DependencyInjection/Compiler/DoctrineInstrumentationPass.php b/src/DependencyInjection/Compiler/DoctrineInstrumentationPass.php
@@ -2,6 +2,7 @@
 
 namespace FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler;
 
+use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
@@ -14,6 +15,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
+        if (!class_exists(DoctrineBundle::class)) {
+            throw new \LogicException('Doctrine instrumentation cannot be enabled because the doctrine/doctrine-bundle package is not installed.');
+        }
+
         $container->getDefinition('open_telemetry.instrumentation.doctrine.trace.middleware')
             ->addTag('doctrine.middleware');
     }

diff --git a/src/DependencyInjection/Compiler/HttpClientInstrumentationPass.php b/src/DependencyInjection/Compiler/HttpClientInstrumentationPass.php
@@ -5,26 +5,33 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpClient\HttpClient;
 
 class HttpClientInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
-        $decoratedService = $this->getDecoratedService($container);
-        if (null === $decoratedService) {
+        if (false === $container->hasParameter('open_telemetry.instrumentation.http_client.tracing.enabled')
+            || false === $container->getParameter('open_telemetry.instrumentation.http_client.tracing.enabled')) {
             $container->removeDefinition('open_telemetry.instrumentation.http_client.trace.client');
 
             return;
         }
 
-        if (true === $container->hasParameter('open_telemetry.instrumentation.http_client.tracing.enabled')
-            && true === $container->getParameter('open_telemetry.instrumentation.http_client.tracing.enabled')) {
-            $container->getDefinition('open_telemetry.instrumentation.http_client.trace.client')
-                ->setArgument('$client', new Reference('.inner'))
-                ->setDecoratedService($decoratedService[0], null, $decoratedService[1]);
-        } else {
+        if (!class_exists(HttpClient::class)) {
+            throw new \LogicException('Http client instrumentation cannot be enabled because the symfony/http-client package is not installed.');
+        }
+
+        $decoratedService = $this->getDecoratedService($container);
+        if (null === $decoratedService) {
             $container->removeDefinition('open_telemetry.instrumentation.http_client.trace.client');
+
+            return;
         }
+
+        $container->getDefinition('open_telemetry.instrumentation.http_client.trace.client')
+            ->setArgument('$client', new Reference('.inner'))
+            ->setDecoratedService($decoratedService[0], null, $decoratedService[1]);
     }
 
     /**

diff --git a/src/DependencyInjection/Compiler/MailerInstrumentationPass.php b/src/DependencyInjection/Compiler/MailerInstrumentationPass.php
@@ -4,6 +4,8 @@
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Mailer\Transport\TransportFactoryInterface;
 
 class MailerInstrumentationPass implements CompilerPassInterface
 {
@@ -14,6 +16,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
+        if (!interface_exists(MailerInterface::class) || !interface_exists(TransportFactoryInterface::class)) {
+            throw new \LogicException('Mailer instrumentation cannot be enabled because the symfony/mailer package is not installed.');
+        }
+
         $container->removeDefinition('open_telemetry.instrumentation.mailer.trace.transports');
         $container->removeDefinition('open_telemetry.instrumentation.mailer.trace.default_transport');
         $container->removeDefinition('open_telemetry.instrumentation.mailer.trace.mailer');

diff --git a/src/DependencyInjection/Compiler/MessengerInstrumentationPass.php b/src/DependencyInjection/Compiler/MessengerInstrumentationPass.php
@@ -4,6 +4,8 @@
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
+use Symfony\Component\Messenger\Transport\TransportFactoryInterface;
 
 class MessengerInstrumentationPass implements CompilerPassInterface
 {
@@ -14,6 +16,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
+        if (!interface_exists(MiddlewareInterface::class) || !interface_exists(TransportFactoryInterface::class)) {
+            throw new \LogicException('Messenger instrumentation cannot be enabled because the symfony/messenger package is not installed.');
+        }
+
         $container
             ->setAlias('messenger.transport.open_telemetry_tracer.factory', 'open_telemetry.instrumentation.messenger.trace.transport_factory');
         $container

diff --git a/src/DependencyInjection/Compiler/TwigInstrumentationPass.php b/src/DependencyInjection/Compiler/TwigInstrumentationPass.php
@@ -2,6 +2,7 @@
 
 namespace FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler;
 
+use Symfony\Bundle\TwigBundle\TwigBundle;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
@@ -14,6 +15,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
+        if (!class_exists(TwigBundle::class)) {
+            throw new \LogicException('Twig instrumentation cannot be enabled because the symfony/twig-bundle package is not installed.');
+        }
+
         $container->getDefinition('open_telemetry.instrumentation.twig.trace.extension')
             ->addTag('twig.extension');
     }