Added name generator service

Author: allflame

src/Bridge/RequestSpanListener.php

@@ -6,6 +6,7 @@
 use Jaeger\Http\HttpCodeTag;
 use Jaeger\Http\HttpMethodTag;
 use Jaeger\Http\HttpUriTag;
+use Jaeger\Symfony\Name\Generator\NameGeneratorInterface;
 use Jaeger\Symfony\Tag\SymfonyComponentTag;
 use Jaeger\Symfony\Tag\SymfonyVersionTag;
 use Jaeger\Symfony\Tag\TimeMicroTag;
@@ -14,7 +15,6 @@
 use Jaeger\Tag\SpanKindServerTag;
 use Jaeger\Tracer\TracerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
@@ -24,11 +24,14 @@ class RequestSpanListener implements EventSubscriberInterface
 {
     private $spans;
 
+    private $nameGenerator;
+
     private $tracer;
 
-    public function __construct(\SplStack $stack, TracerInterface $tracer)
+    public function __construct(\SplStack $stack, NameGeneratorInterface $nameGenerator, TracerInterface $tracer)
     {
         $this->spans = $stack;
+        $this->nameGenerator = $nameGenerator;
         $this->tracer = $tracer;
     }
 
@@ -57,7 +60,7 @@ public function onRequest(GetResponseEvent $event)
     {
         $request = $event->getRequest();
         $requestSpan = $this->tracer->start(
-            $this->getOperationName($request),
+            $this->nameGenerator->generate(),
             [
                 new HttpMethodTag($request->getMethod()),
                 new HttpUriTag($request->getRequestUri()),
@@ -81,19 +84,4 @@ public function onRequest(GetResponseEvent $event)
 
         return $this;
     }
-
-    public function getOperationName(Request $request)
-    {
-        if (null !== ($fragment = $request->attributes->get('is_fragment'))) {
-            return ($controller = $request->attributes->get('_controller', null))
-                ? sprintf('fragment.%s', $controller)
-                : 'fragment';
-        }
-
-        if (null === ($routeName = $request->attributes->get('_route', null))) {
-            return $request->getRequestUri();
-        }
-
-        return $routeName;
-    }
 }

src/Name/Generator/DefaultNameGenerator.php

@@ -0,0 +1,67 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Symfony\Name\Generator;
+
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+{
+    private $name = '';
+
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            KernelEvents::REQUEST => ['onRequest', 8192],
+            ConsoleEvents::COMMAND => ['onCommand', 8192],
+            KernelEvents::TERMINATE => ['onTerminate'],
+            ConsoleEvents::TERMINATE => ['onTerminate'],
+        ];
+    }
+
+    public function onCommand(ConsoleCommandEvent $event)
+    {
+        $this->name = $event->getCommand()->getName();
+
+        return $this;
+    }
+
+    public function onRequest(GetResponseEvent $event)
+    {
+        $request = $event->getRequest();
+        if (null !== ($fragment = $request->attributes->get('is_fragment'))) {
+            $this->name = ($controller = $request->attributes->get('_controller', null))
+                ? sprintf('fragment.%s', $controller)
+                : 'fragment';
+
+            return $this;
+        }
+
+        if (null === ($routeName = $request->attributes->get('_route', null))) {
+            $this->name = $request->getRequestUri();
+
+            return $this;
+        }
+
+        $this->name = $routeName;
+
+        return $this;
+    }
+
+    public function onTerminate()
+    {
+        $this->name = '';
+
+        return $this;
+    }
+
+    public function generate(): string
+    {
+        return $this->name;
+    }
+}

src/Name/Generator/NameGeneratorChain.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Symfony\Name\Generator;
+
+class NameGeneratorChain implements NameGeneratorInterface
+{
+    private $queue;
+
+    public function __construct(\SplPriorityQueue $queue)
+    {
+        $this->queue = $queue;
+    }
+
+    public function add(NameGeneratorInterface $extractor, int $priority = 0): NameGeneratorChain
+    {
+        $this->queue->insert($extractor, $priority);
+
+        return $this;
+    }
+
+    public function generate(): string
+    {
+        $queue = clone $this->queue;
+        while (false === $queue->isEmpty()) {
+            if ('' !== ($debugId = $queue->extract()->generate())) {
+                return $debugId;
+            }
+        }
+
+        return '';
+    }
+}

src/Name/Generator/NameGeneratorInterface.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Symfony\Name\Generator;
+
+interface NameGeneratorInterface
+{
+    public function generate() : string;
+}

src/Resources/DependencyInjection/NameGeneratorChainCompilerPass.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Symfony\Resources\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class NameGeneratorChainCompilerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (false === $container->hasDefinition('jaeger.name.generator.chain')) {
+            throw new \RuntimeException(
+                sprintf('Required service %s is missing from container', 'jaeger.name.generator.chain')
+            );
+        }
+
+        $definition = $container->getDefinition('jaeger.name.generator.chain');
+        foreach ($container->findTaggedServiceIds('jaeger.name.generator') as $id => $tags) {
+            foreach ($tags as $tag) {
+                $priority = $tag['priority'] ?? 0;
+                $definition->addMethodCall('add', [new Reference($id), $priority]);
+            }
+        }
+    }
+}

src/Resources/config/services.yml

@@ -113,6 +113,17 @@ services:
       - '@spl.priority.queue'
   jaeger.debug.extractor:
     alias: 'jaeger.debug.extractor.chain'
+  jaeger.name.generator.default:
+    class: Jaeger\Symfony\Name\Generator\DefaultNameGenerator
+    tags:
+      - {name: 'kernel.event_subscriber' }
+      - {name: 'jaeger.name.generator', priority: -1}
+  jaeger.name.generator.chain:
+    class: Jaeger\Symfony\Name\Generator\NameGeneratorChain
+    arguments:
+      - '@spl.priority.queue'
+  jaeger.name.generator:
+    alias: 'jaeger.name.generator.chain'
   jaeger.debug.listener:
     class: Jaeger\Symfony\Bridge\DebugListener
     arguments:
@@ -131,6 +142,7 @@ services:
     class: Jaeger\Symfony\Bridge\RequestSpanListener
     arguments:
       - '@spl.stack'
+      - '@jaeger.name.generator'
       - '@jaeger.tracer'
     tags:
       - {name: 'kernel.event_subscriber' }