Allow arbitary generation of span names based on the route matched

allflame · allflame · commit fb79a4bdc341 · 2021-04-22T11:18:57.000+03:00
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -28,6 +28,20 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('name_generator')
+                    ->canBeEnabled()
+                    ->children()
+                        ->scalarNode('max_length')->defaultValue(64)->end()
+                        ->arrayNode('command')
+                            ->useAttributeAsKey('name')
+                            ->scalarPrototype()->end()
+                        ->end()
+                        ->arrayNode('request')
+                            ->useAttributeAsKey('name')
+                            ->scalarPrototype()->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end();
         // @formatter:on
 
diff --git a/src/DependencyInjection/JaegerExtension.php b/src/DependencyInjection/JaegerExtension.php
@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace Jaeger\Symfony\DependencyInjection;
@@ -8,6 +7,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\DependencyInjection\Reference;
 
 class JaegerExtension extends Extension
 {
@@ -18,13 +18,26 @@ public function load(array $configs, ContainerBuilder $container)
             new FileLocator(__DIR__ . '/../Resources')
         );
         $loader->load('services.yml');
-
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
-
         if ($this->isConfigEnabled($container, $config['denylist'])) {
             $container->setParameter('jaeger.sampler.operation_denylist', $config['denylist']['operation_names']);
             $loader->load('denylist.yml');
         }
+        if ($this->isConfigEnabled($container, $config['name_generator'])) {
+            $container->setParameter('jaeger.name.max_length', (int)$config['name_generator']['max_length']);
+            foreach ($config['name_generator']['request'] as $item => $alias) {
+                $container->getDefinition('jaeger.name.generator.request')->addMethodCall(
+                    'add',
+                    [$item, new Reference($alias)]
+                );
+            }
+            foreach ($config['name_generator']['command'] as $item => $alias) {
+                $container->getDefinition('jaeger.name.generator.command')->addMethodCall(
+                    'add',
+                    [$item, new Reference($alias)]
+                );
+            }
+        }
     }
 }
diff --git a/src/Name/Generator/AbstractGeneratorDecorator.php b/src/Name/Generator/AbstractGeneratorDecorator.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Jaeger\Symfony\Name\Generator;
+
+abstract class AbstractGeneratorDecorator implements NameGeneratorInterface
+{
+    private NameGeneratorInterface $generator;
+
+    public function __construct(NameGeneratorInterface $generator)
+    {
+        $this->generator = $generator;
+    }
+
+    public function generate(): string
+    {
+        return $this->generator->generate();
+    }
+}
diff --git a/src/Name/Generator/CommandNameGenerator.php b/src/Name/Generator/CommandNameGenerator.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Jaeger\Symfony\Name\Generator;
+
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class CommandNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+{
+    private array $generators;
+
+    private string $name;
+
+    public function __construct(array $generators = [])
+    {
+        $this->generators = $generators;
+    }
+
+    public function add(string $regexp, NameGeneratorInterface $generator): CommandNameGenerator
+    {
+        $this->generators[sprintf('/%s/', $regexp)] = $generator;
+
+        return $this;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [ConsoleCommandEvent::class => ['onCommand', 30], ConsoleTerminateEvent::class => ['onTerminate'],];
+    }
+
+    public function onCommand(ConsoleCommandEvent $event): void
+    {
+        if (null === $event->getCommand()) {
+            return;
+        }
+
+        $this->name = (string)$event->getCommand()->getName();
+    }
+
+    public function onTerminate(): CommandNameGenerator
+    {
+        $this->name = '';
+
+        return $this;
+    }
+
+    public function generate(): string
+    {
+        foreach ($this->generators as $regexp => $generator) {
+            if (false === \preg_match($regexp, $this->name)) {
+                continue;
+            }
+
+            return $generator->generate();
+        }
+
+        return '';
+    }
+}
diff --git a/src/Name/Generator/DefaultNameGenerator.php b/src/Name/Generator/DefaultNameGenerator.php
@@ -11,9 +11,7 @@
 
 class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
 {
-    private $name = '';
-
-    public const MAX_LENGTH = 64;
+    private string $name = '';
 
     public static function getSubscribedEvents(): array
     {
@@ -27,29 +25,23 @@ public static function getSubscribedEvents(): array
 
     public function onCommand(ConsoleCommandEvent $event): void
     {
-        $this->name = $event->getCommand()->getName();
-    }
-
-    public function setName(string $name)
-    {
-        if (self::MAX_LENGTH < strlen($name)) {
-            $name = substr($name, 0, self::MAX_LENGTH);
+        if (null === $event->getCommand()) {
+            return;
         }
-        $this->name = $name;
+
+        $this->name = (string)$event->getCommand()->getName();
     }
 
     public function onRequest(RequestEvent $event): void
     {
         $request = $event->getRequest();
         if (null !== ($fragment = $request->attributes->get('is_fragment'))) {
-            $name = ($controller = $request->attributes->get('_controller', null))
+            $this->name = ($controller = $request->attributes->get('_controller', null))
                 ? sprintf('fragment.%s', $controller)
                 : 'fragment';
-            $this->setName($name);
-
             return;
         }
-        $this->setName($request->attributes->get('_route', $request->getRequestUri()));
+        $this->name = $request->attributes->get('_route', $request->getRequestUri());
     }
 
     public function onTerminate(): void
diff --git a/src/Name/Generator/NameGeneratorChain.php b/src/Name/Generator/NameGeneratorChain.php
@@ -5,7 +5,7 @@
 
 class NameGeneratorChain implements NameGeneratorInterface
 {
-    private $queue;
+    private \SplPriorityQueue $queue;
 
     public function __construct(\SplPriorityQueue $queue)
     {
diff --git a/src/Name/Generator/RequestNameGenerator.php b/src/Name/Generator/RequestNameGenerator.php
@@ -0,0 +1,56 @@
+<?php
+
+namespace Jaeger\Symfony\Name\Generator;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+
+class RequestNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+{
+    private array $generators;
+
+    private string $route;
+
+    public function __construct(array $generators = [])
+    {
+        $this->generators = $generators;
+    }
+
+    public function add(string $regexp, NameGeneratorInterface $generator): RequestNameGenerator
+    {
+        $this->generators[sprintf('/%s/', $regexp)] = $generator;
+
+        return $this;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [RequestEvent::class => ['onRequest', 30], TerminateEvent::class => ['onTerminate', -16384],];
+    }
+
+    public function onRequest(RequestEvent $event): void
+    {
+        $this->route = $event->getRequest()->attributes->get('_route', $event->getRequest()->getRequestUri());
+    }
+
+    public function onTerminate(): RequestNameGenerator
+    {
+        $this->route = '';
+
+        return $this;
+    }
+
+    public function generate(): string
+    {
+        foreach ($this->generators as $regexp => $generator) {
+            if (1 !== \preg_match($regexp, $this->route)) {
+                continue;
+            }
+
+            return $generator->generate();
+        }
+
+        return '';
+    }
+}
diff --git a/src/Name/Generator/ShortenGeneratorDecorator.php b/src/Name/Generator/ShortenGeneratorDecorator.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Jaeger\Symfony\Name\Generator;
+
+class ShortenGeneratorDecorator extends AbstractGeneratorDecorator
+{
+    private int $maxLength;
+
+    public function __construct(NameGeneratorInterface $generator, int $maxLength)
+    {
+        $this->maxLength = $maxLength;
+        parent::__construct($generator);
+    }
+
+    public function shorten(string $name)
+    {
+        if ($this->maxLength >= strlen($name)) {
+            return $name;
+        }
+
+        return \substr($name, 0, $this->maxLength);
+    }
+
+    public function generate(): string
+    {
+        return $this->shorten(parent::generate());
+    }
+}
diff --git a/src/Resources/services.yml b/src/Resources/services.yml
@@ -12,6 +12,8 @@ parameters:
   env(JAEGER_DEBUG_COOKIE): 'debug'
   env(JAEGER_SERVICE_NAME): '%service_name%'
   env(JAEGER_SPAN_BATCH): '16'
+  jaeger.name.max_length: 64
+
 services:
   spl.stack:
     class: SplStack
@@ -130,12 +132,26 @@ services:
     tags:
       - {name: 'kernel.event_subscriber' }
       - {name: 'jaeger.name.generator', priority: -1}
+  jaeger.name.generator.request:
+    class: Jaeger\Symfony\Name\Generator\RequestNameGenerator
+    tags:
+      - {name: 'kernel.event_subscriber' }
+      - {name: 'jaeger.name.generator', priority: 1}
+  jaeger.name.generator.command:
+    class: Jaeger\Symfony\Name\Generator\CommandNameGenerator
+    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.name.generator.shorten:
+    class: Jaeger\Symfony\Name\Generator\ShortenGeneratorDecorator
+    decorates: '@jaeger.name.generator'
+    arguments: ['@jaeger.name.generator.shorten.inner', '%jaeger.name.max_length%']
   jaeger.span.handler.background:
     class: Jaeger\Symfony\Bridge\BackgroundSpanHandler
     arguments: ['@jaeger.tracer']

Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,7 @@`
`11`	`11`
`12`	`12`	`class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface`
`13`	`13`	`{`
`14`		`- private $name = '';`
`15`		`-`
`16`		`- public const MAX_LENGTH = 64;`
	`14`	`+ private string $name = '';`
`17`	`15`
`18`	`16`	`public static function getSubscribedEvents(): array`
`19`	`17`	`{`
`@@ -27,29 +25,23 @@ public static function getSubscribedEvents(): array`
`27`	`25`
`28`	`26`	`public function onCommand(ConsoleCommandEvent $event): void`
`29`	`27`	`{`
`30`		`- $this->name = $event->getCommand()->getName();`
`31`		`- }`
`32`		`-`
`33`		`- public function setName(string $name)`
`34`		`- {`
`35`		`- if (self::MAX_LENGTH < strlen($name)) {`
`36`		`- $name = substr($name, 0, self::MAX_LENGTH);`
	`28`	`+ if (null === $event->getCommand()) {`
	`29`	`+ return;`
`37`	`30`	`}`
`38`		`- $this->name = $name;`
	`31`	`+`
	`32`	`+ $this->name = (string)$event->getCommand()->getName();`
`39`	`33`	`}`
`40`	`34`
`41`	`35`	`public function onRequest(RequestEvent $event): void`
`42`	`36`	`{`
`43`	`37`	`$request = $event->getRequest();`
`44`	`38`	`if (null !== ($fragment = $request->attributes->get('is_fragment'))) {`
`45`		`- $name = ($controller = $request->attributes->get('_controller', null))`
	`39`	`+ $this->name = ($controller = $request->attributes->get('_controller', null))`
`46`	`40`	`? sprintf('fragment.%s', $controller)`
`47`	`41`	`: 'fragment';`
`48`		`- $this->setName($name);`
`49`		`-`
`50`	`42`	`return;`
`51`	`43`	`}`
`52`		`- $this->setName($request->attributes->get('_route', $request->getRequestUri()));`
	`44`	`+ $this->name = $request->attributes->get('_route', $request->getRequestUri());`
`53`	`45`	`}`
`54`	`46`
`55`	`47`	`public function onTerminate(): void`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`class NameGeneratorChain implements NameGeneratorInterface`
`7`	`7`	`{`
`8`		`- private $queue;`
	`8`	`+ private \SplPriorityQueue $queue;`
`9`	`9`
`10`	`10`	`public function __construct(\SplPriorityQueue $queue)`
`11`	`11`	`{`