refactor(DependencyInjection): move configurate in compiler passes

FriendsOfOpenTelemetry · Jan 13, 2025 · d8c7610 · d8c7610
1 parent 24c7fc3
commit d8c7610
Show file tree

Hide file tree

Showing 21 changed files with 184 additions and 161 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd"
     bootstrap="vendor/autoload.php"
     executionOrder="depends,defects"
     beStrictAboutOutputDuringTests="true"

diff --git a/src/DependencyInjection/Compiler/CacheInstrumentationPass.php b/src/DependencyInjection/Compiler/CacheInstrumentationPass.php
@@ -0,0 +1,73 @@
+<?php
+
+namespace FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ChildDefinition;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+class CacheInstrumentationPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        if (false === $container->hasParameter('open_telemetry.instrumentation.cache.tracing.enabled')
+            || false === $container->getParameter('open_telemetry.instrumentation.cache.tracing.enabled')) {
+            $container->removeDefinition('open_telemetry.instrumentation.cache.trace.tag_aware_adapter');
+            $container->removeDefinition('open_telemetry.instrumentation.cache.trace.adapter');
+
+            return;
+        }
+
+        foreach ($container->findTaggedServiceIds('cache.pool') as $serviceId => $tags) {
+            $cachePoolDefinition = $container->getDefinition($serviceId);
+            if ($cachePoolDefinition->isAbstract()) {
+                continue;
+            }
+
+            $definitionClass = $this->resolveDefinitionClass($container, $cachePoolDefinition);
+            if (null === $definitionClass) {
+                continue;
+            }
+
+            $traceableCachePoolDefinition = new ChildDefinition('open_telemetry.instrumentation.cache.trace.adapter');
+            $traceableCachePoolDefinition
+                ->setDecoratedService($serviceId)
+                ->setArgument('$adapter', new Reference('.inner'));
+
+            $container->setDefinition($serviceId.'.tracer', $traceableCachePoolDefinition);
+        }
+
+        foreach ($container->findTaggedServiceIds('cache.taggable') as $serviceId => $tags) {
+            $cachePoolDefinition = $container->getDefinition($serviceId);
+            if ($cachePoolDefinition->isAbstract()) {
+                continue;
+            }
+
+            $definitionClass = $this->resolveDefinitionClass($container, $cachePoolDefinition);
+            if (null === $definitionClass) {
+                continue;
+            }
+
+            $traceableCachePoolDefinition = new ChildDefinition('open_telemetry.instrumentation.cache.trace.tag_aware_adapter');
+            $traceableCachePoolDefinition
+                ->setDecoratedService($serviceId)
+                ->setArgument('$adapter', new Reference('.inner'));
+
+            $container->setDefinition($serviceId.'.tracer', $traceableCachePoolDefinition);
+        }
+    }
+
+    private function resolveDefinitionClass(ContainerBuilder $container, Definition $definition): ?string
+    {
+        $class = $definition->getClass();
+
+        while (null === $class && $definition instanceof ChildDefinition) {
+            $definition = $container->findDefinition($definition->getParent());
+            $class = $definition->getClass();
+        }
+
+        return $class;
+    }
+}
diff --git a/src/DependencyInjection/Compiler/CachePoolTracingPass.php b/src/DependencyInjection/Compiler/CachePoolTracingPass.php
diff --git a/...iler/RemoveConsoleInstrumentationPass.php → ...n/Compiler/ConsoleInstrumentationPass.php b/...iler/RemoveConsoleInstrumentationPass.php → ...n/Compiler/ConsoleInstrumentationPass.php
@@ -5,17 +5,19 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
-class RemoveConsoleInstrumentationPass implements CompilerPassInterface
+class ConsoleInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasParameter('open_telemetry.instrumentation.console.tracing.enabled')
             || false === $container->getParameter('open_telemetry.instrumentation.console.tracing.enabled')) {
             $container->removeDefinition('open_telemetry.instrumentation.console.trace.event_subscriber');
-        }
 
-        if (false === $container->hasParameter('open_telemetry.instrumentation.console.metering.enabled')
-            || false === $container->getParameter('open_telemetry.instrumentation.console.metering.enabled')) {
+            return;
         }
+
+        $container
+            ->getDefinition('open_telemetry.instrumentation.console.trace.event_subscriber')
+            ->addTag('kernel.event_subscriber');
     }
 }
diff --git a/...ler/RemoveDoctrineInstrumentationPass.php → .../Compiler/DoctrineInstrumentationPass.php b/...ler/RemoveDoctrineInstrumentationPass.php → .../Compiler/DoctrineInstrumentationPass.php
@@ -5,17 +5,19 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
-class RemoveDoctrineInstrumentationPass implements CompilerPassInterface
+class DoctrineInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasParameter('open_telemetry.instrumentation.doctrine.tracing.enabled')
             || false === $container->getParameter('open_telemetry.instrumentation.doctrine.tracing.enabled')) {
             $container->removeDefinition('open_telemetry.instrumentation.doctrine.trace.middleware');
-        }
 
-        if (false === $container->hasParameter('open_telemetry.instrumentation.doctrine.metering.enabled')
-            || false === $container->getParameter('open_telemetry.instrumentation.doctrine.metering.enabled')) {
+            return;
         }
+
+        $container
+            ->getDefinition('open_telemetry.instrumentation.doctrine.trace.middleware')
+            ->addTag('doctrine.middleware');
     }
 }
diff --git a/...ection/Compiler/HttpClientTracingPass.php → ...ompiler/HttpClientInstrumentationPass.php b/...ection/Compiler/HttpClientTracingPass.php → ...ompiler/HttpClientInstrumentationPass.php
@@ -6,7 +6,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-class HttpClientTracingPass implements CompilerPassInterface
+class HttpClientInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {

diff --git a/...r/RemoveHttpKernelInstrumentationPass.php → ...ompiler/HttpKernelInstrumentationPass.php b/...r/RemoveHttpKernelInstrumentationPass.php → ...ompiler/HttpKernelInstrumentationPass.php
@@ -5,17 +5,20 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
-class RemoveHttpKernelInstrumentationPass implements CompilerPassInterface
+class HttpKernelInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasParameter('open_telemetry.instrumentation.http_kernel.tracing.enabled')
             || false === $container->getParameter('open_telemetry.instrumentation.http_kernel.tracing.enabled')) {
             $container->removeDefinition('open_telemetry.instrumentation.http_kernel.trace.event_subscriber');
-        }
+            $container->removeDefinition('open_telemetry.instrumentation.http_kernel.trace.route_loader');
 
-        if (false === $container->hasParameter('open_telemetry.instrumentation.http_kernel.metering.enabled')
-            || false === $container->getParameter('open_telemetry.instrumentation.http_kernel.metering.enabled')) {
+            return;
         }
+
+        $container
+            ->getDefinition('open_telemetry.instrumentation.http_kernel.trace.event_subscriber')
+            ->addTag('kernel.event_subscriber');
     }
 }
diff --git a/...piler/RemoveMailerInstrumentationPass.php → ...on/Compiler/MailerInstrumentationPass.php b/...piler/RemoveMailerInstrumentationPass.php → ...on/Compiler/MailerInstrumentationPass.php
@@ -5,7 +5,7 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
-class RemoveMailerInstrumentationPass implements CompilerPassInterface
+class MailerInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
@@ -14,10 +14,8 @@ public function process(ContainerBuilder $container): void
             $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');
-        }
 
-        if (false === $container->hasParameter('open_telemetry.instrumentation.mailer.metering.enabled')
-            || false === $container->getParameter('open_telemetry.instrumentation.mailer.metering.enabled')) {
+            return;
         }
     }
 }
diff --git a/...er/RemoveMessengerInstrumentationPass.php → ...Compiler/MessengerInstrumentationPass.php b/...er/RemoveMessengerInstrumentationPass.php → ...Compiler/MessengerInstrumentationPass.php
@@ -5,10 +5,18 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
-class RemoveMessengerInstrumentationPass implements CompilerPassInterface
+class MessengerInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
+        $container
+            ->getDefinition('open_telemetry.instrumentation.messenger.trace.transport_factory')
+            ->addTag('messenger.transport_factory')
+            ->addTag('kernel.reset', ['method' => 'reset']);
+
+        $container->setAlias('messenger.transport.open_telemetry_tracer.factory', 'open_telemetry.instrumentation.messenger.trace.transport_factory');
+        $container->setAlias('messenger.middleware.open_telemetry_tracer', 'open_telemetry.instrumentation.messenger.trace.middleware');
+
         if (false === $container->hasParameter('open_telemetry.instrumentation.messenger.tracing.enabled')
             || false === $container->getParameter('open_telemetry.instrumentation.messenger.tracing.enabled')) {
             $container->removeAlias('messenger.transport.open_telemetry_tracer.factory');
@@ -18,9 +26,5 @@ public function process(ContainerBuilder $container): void
             $container->removeDefinition('open_telemetry.instrumentation.messenger.trace.transport_factory');
             $container->removeDefinition('open_telemetry.instrumentation.messenger.trace.middleware');
         }
-
-        if (false === $container->hasParameter('open_telemetry.instrumentation.messenger.metering.enabled')
-            || false === $container->getParameter('open_telemetry.instrumentation.messenger.metering.enabled')) {
-        }
     }
 }
diff --git a/src/DependencyInjection/Compiler/TracerLocatorPass.php b/src/DependencyInjection/Compiler/TracerLocatorPass.php
@@ -14,7 +14,7 @@ public function process(ContainerBuilder $container): void
     {
         $tracers = $container->findTaggedServiceIds('open_telemetry.tracer');
 
-        if (0 !== count($tracers)) {
+        if (0 < count($tracers)) {
             if ($container->has('open_telemetry.instrumentation.console.trace.event_subscriber')) {
                 $traceableConsoleEventSubscriber = $container->getDefinition('open_telemetry.instrumentation.console.trace.event_subscriber');
                 $this->setTracerLocatorArgument($container, $traceableConsoleEventSubscriber, $tracers);

diff --git a/...ompiler/RemoveTwigInstrumentationPass.php → ...tion/Compiler/TwigInstrumentationPass.php b/...ompiler/RemoveTwigInstrumentationPass.php → ...tion/Compiler/TwigInstrumentationPass.php
@@ -5,17 +5,19 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
-class RemoveTwigInstrumentationPass implements CompilerPassInterface
+class TwigInstrumentationPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasParameter('open_telemetry.instrumentation.twig.tracing.enabled')
             || false === $container->getParameter('open_telemetry.instrumentation.twig.tracing.enabled')) {
             $container->removeDefinition('open_telemetry.instrumentation.twig.trace.extension');
-        }
 
-        if (false === $container->hasParameter('open_telemetry.instrumentation.twig.metering.enabled')
-            || false === $container->getParameter('open_telemetry.instrumentation.twig.metering.enabled')) {
+            return;
         }
+
+        $container
+            ->getDefinition('open_telemetry.instrumentation.twig.trace.extension')
+            ->addTag('twig.extension');
     }
 }
diff --git a/src/OpenTelemetryBundle.php b/src/OpenTelemetryBundle.php
@@ -3,16 +3,16 @@
 namespace FriendsOfOpenTelemetry\OpenTelemetryBundle;
 
 use Composer\InstalledVersions;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\CachePoolTracingPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\HttpClientTracingPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\RemoveConsoleInstrumentationPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\RemoveDoctrineInstrumentationPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\RemoveHttpKernelInstrumentationPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\RemoveMailerInstrumentationPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\RemoveMessengerInstrumentationPass;
-use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\RemoveTwigInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\CacheInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\ConsoleInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\DoctrineInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\HttpClientInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\HttpKernelInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\MailerInstrumentationPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\MessengerInstrumentationPass;
 use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\SetInstrumentationTypePass;
 use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\TracerLocatorPass;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\DependencyInjection\Compiler\TwigInstrumentationPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -33,15 +33,16 @@ public function build(ContainerBuilder $container): void
         parent::build($container);
 
         $container->addCompilerPass(new SetInstrumentationTypePass());
-        $container->addCompilerPass(new CachePoolTracingPass());
-        $container->addCompilerPass(new HttpClientTracingPass());
+
+        $container->addCompilerPass(new CacheInstrumentationPass());
+        $container->addCompilerPass(new ConsoleInstrumentationPass());
+        $container->addCompilerPass(new DoctrineInstrumentationPass());
+        $container->addCompilerPass(new HttpClientInstrumentationPass());
+        $container->addCompilerPass(new HttpKernelInstrumentationPass());
+        $container->addCompilerPass(new MailerInstrumentationPass());
+        $container->addCompilerPass(new MessengerInstrumentationPass());
+        $container->addCompilerPass(new TwigInstrumentationPass());
+
         $container->addCompilerPass(new TracerLocatorPass());
-        $container->addCompilerPass(new RemoveConsoleInstrumentationPass());
-        $container->addCompilerPass(new RemoveDoctrineInstrumentationPass());
-        $container->addCompilerPass(new RemoveHttpKernelInstrumentationPass());
-        $container->addCompilerPass(new RemoveMailerInstrumentationPass());
-        $container->addCompilerPass(new RemoveMessengerInstrumentationPass());
-        $container->addCompilerPass(new RemoveTwigInstrumentationPass());
-        $container->addCompilerPass(new RemoveTwigInstrumentationPass());
     }
 }