Merge pull request #16 from code-tool/name-generator

allflame · web-flow · commit 4bbc15b07132 · 2021-06-29T12:34:59.000+03:00
Name generator
diff --git a/README.md b/README.md
@@ -36,3 +36,29 @@ jaeger:
       - 'healthcheck'
       - 'metrics'
 ```
+
+
+## Name generation options
+
+You can configure custom name generators based on regular expression pattern, which will be evaluated for operation name.
+
+Configuration for this feature looks like key-value list, where key - regexp pattern, value - custom name generator DI service id (see details below).
+
+Name generator should implement an `Jaeger\Symfony\Name\Generator\NameGeneratorInterface` interface.
+As a custom name generator you can specify a full DI service id, or just the suffix if your name generator service is named as `jaeger.name.generator.*`.
+Keys are considered body of the regular expression pattern, do not put any modifiers (e.g. `/i`, `/g`) or slashes; `route` of the request or `name` of the command should match to use alternative generator.
+Expressions are checked top to bottom, if no match is found, default generator will be used
+
+Example bundle config with name generation feature:
+
+```yaml
+# config/jaeger.yaml
+jaeger:
+  name_generator:
+    max_length: 32
+    command:  
+      '^app:report:.+': 'my_service_generator_alias'
+      .* : 'controller'
+    request:
+      'user_routes_\w+': 'my_service_generator_alias'
+```
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
     }
   },
   "require": {
-    "php": ">=7.1",
+    "php": ">=7.4",
     "code-tool/jaeger-client-php": "^3.1",
     "symfony/config": "^4.3|^5.0",
     "symfony/console": "^4.3|^5.0",
diff --git a/src/Bridge/BackgroundSpanHandler.php b/src/Bridge/BackgroundSpanHandler.php
@@ -5,7 +5,7 @@
 
 use Jaeger\Http\HttpMethodTag;
 use Jaeger\Http\HttpUriTag;
-use Jaeger\Span\Span;
+use Jaeger\Span\SpanInterface;
 use Jaeger\Symfony\Tag\SymfonyBackgroundTag;
 use Jaeger\Symfony\Tag\SymfonyComponentTag;
 use Jaeger\Symfony\Tag\SymfonyVersionTag;
@@ -15,12 +15,9 @@
 
 class BackgroundSpanHandler
 {
-    /**
-     * @var Span
-     */
-    private $span;
+    private ?SpanInterface $span = null;
 
-    private $tracer;
+    private TracerInterface $tracer;
 
     public function __construct(TracerInterface $tracer)
     {
@@ -50,6 +47,7 @@ public function flush(): BackgroundSpanHandler
             return $this;
         }
         $this->span->finish();
+        $this->span = null;
 
         return $this;
     }
diff --git a/src/Bridge/GlobalSpanListener.php b/src/Bridge/GlobalSpanListener.php
@@ -10,29 +10,29 @@
 
 class GlobalSpanListener implements EventSubscriberInterface
 {
-    private $handler;
+    private GlobalSpanHandler $handler;
 
     public function __construct(GlobalSpanHandler $handler)
     {
         $this->handler = $handler;
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             RequestEvent::class => ['onRequest', 30],
             TerminateEvent::class => ['onTerminate', 4096],
         ];
     }
 
-    public function onTerminate()
+    public function onTerminate(): GlobalSpanListener
     {
         $this->handler->finish();
 
         return $this;
     }
 
-    public function onRequest(RequestEvent $event)
+    public function onRequest(RequestEvent $event): GlobalSpanListener
     {
         if (false === $this->isMainRequestEvent($event)) {
             return $this;
diff --git a/src/Bridge/HandlerFlushListener.php b/src/Bridge/HandlerFlushListener.php
@@ -18,9 +18,9 @@ public function __construct(BackgroundSpanHandler $backgroundHandler, GlobalSpan
         $this->globalHandler = $globalHandler;
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
-        return [TerminateEvent::class => ['onTerminate', -16384],];
+        return [TerminateEvent::class => ['onTerminate', -16384]];
     }
 
     public function onTerminate()
diff --git a/src/Context/Extractor/ContextExtractorChain.php b/src/Context/Extractor/ContextExtractorChain.php
@@ -25,7 +25,10 @@ public function extract(): ?SpanContext
     {
         $queue = clone $this->queue;
         while (false === $queue->isEmpty()) {
-            if (null !== ($context = $queue->extract()->extract())) {
+            /** @var ContextExtractorInterface $extractor */
+            $extractor = $queue->extract();
+            $context = $extractor->extract();
+            if (null !== $context) {
                 return $context;
             }
         }
diff --git a/src/Debug/Extractor/DebugExtractorChain.php b/src/Debug/Extractor/DebugExtractorChain.php
@@ -23,7 +23,10 @@ public function getDebug(): string
     {
         $queue = clone $this->queue;
         while (false === $queue->isEmpty()) {
-            if ('' !== ($debugId = $queue->extract()->getDebug())) {
+            /** @var DebugExtractorInterface $extractor */
+            $extractor = $queue->extract();
+            $debugId = $extractor->getDebug();
+            if ('' !== $debugId) {
                 return $debugId;
             }
         }
diff --git a/src/DependencyInjection/CodecRegistryCompilerPass.php b/src/DependencyInjection/CodecRegistryCompilerPass.php
@@ -9,7 +9,7 @@
 
 class CodecRegistryCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.codec.registry')) {
             throw new \RuntimeException(
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()
+                        ->integerNode('max_length')->defaultValue(64)->end()
+                        ->arrayNode('command')
+                            ->useAttributeAsKey('pattern')
+                            ->scalarPrototype()->end()
+                        ->end()
+                        ->arrayNode('request')
+                            ->useAttributeAsKey('pattern')
+                            ->scalarPrototype()->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end();
         // @formatter:on
 
diff --git a/src/DependencyInjection/ContextExtractorChainCompilerPass.php b/src/DependencyInjection/ContextExtractorChainCompilerPass.php
@@ -9,7 +9,7 @@
 
 class ContextExtractorChainCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.context.extractor.chain')) {
             throw new \RuntimeException(
diff --git a/src/DependencyInjection/DebugExtractorChainCompilerPass.php b/src/DependencyInjection/DebugExtractorChainCompilerPass.php
@@ -9,7 +9,7 @@
 
 class DebugExtractorChainCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.debug.extractor.chain')) {
             throw new \RuntimeException(
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,10 +7,11 @@
 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
 {
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader(
             $container,
@@ -26,5 +26,42 @@ public function load(array $configs, ContainerBuilder $container)
             $container->setParameter('jaeger.sampler.operation_denylist', $config['denylist']['operation_names']);
             $loader->load('denylist.yml');
         }
+
+        if ($this->isConfigEnabled($container, $config['name_generator'])) {
+            if ($config['name_generator']['max_length']) {
+                $loader->load('shorten.yml');
+                $container->setParameter('jaeger.name.max_length', $config['name_generator']['max_length']);
+            }
+
+            foreach ($config['name_generator']['request'] as $pattern => $customGeneratorId) {
+                $regexp = \sprintf('/%s/', $pattern);
+
+                $shortenedGeneratorId = \sprintf('jaeger.name.generator.%s', $customGeneratorId);
+                if ($container->has($shortenedGeneratorId)) {
+                    $customGeneratorId = $shortenedGeneratorId;
+                }
+
+                $container->getDefinition('jaeger.name.generator.request')
+                    ->addMethodCall(
+                        'add',
+                        [$regexp, new Reference($customGeneratorId)]
+                    );
+            }
+
+            foreach ($config['name_generator']['command'] as $pattern => $customGeneratorId) {
+                $regexp = \sprintf('/%s/', $pattern);
+
+                $shortenedGeneratorId = \sprintf('jaeger.name.generator.%s', $customGeneratorId);
+                if ($container->has($shortenedGeneratorId)) {
+                    $customGeneratorId = $shortenedGeneratorId;
+                }
+
+                $container->getDefinition('jaeger.name.generator.command')
+                    ->addMethodCall(
+                        'add',
+                        [$regexp, new Reference($customGeneratorId)]
+                    );
+            }
+        }
     }
 }
diff --git a/src/DependencyInjection/NameGeneratorChainCompilerPass.php b/src/DependencyInjection/NameGeneratorChainCompilerPass.php
@@ -9,7 +9,7 @@
 
 class NameGeneratorChainCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.name.generator.chain')) {
             throw new \RuntimeException(
diff --git a/src/JaegerBundle.php b/src/JaegerBundle.php
@@ -13,7 +13,7 @@
 
 class JaegerBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
         $container
diff --git a/src/Name/Generator/AbstractGeneratorDecorator.php b/src/Name/Generator/AbstractGeneratorDecorator.php
@@ -0,0 +1,19 @@
+<?php
+declare(strict_types=1);
+
+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,71 @@
+<?php
+declare(strict_types=1);
+
+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
+{
+    /**
+     * @var NameGeneratorInterface[] Key - regexp, value - name generator
+     */
+    private array $generators;
+
+    private string $name = '';
+
+    /**
+     * @param NameGeneratorInterface[] $generators Key - regexp, value - name generator
+     */
+    public function __construct(array $generators = [])
+    {
+        $this->generators = $generators;
+    }
+
+    public function add(string $regexp, NameGeneratorInterface $generator): CommandNameGenerator
+    {
+        $this->generators[$regexp] = $generator;
+
+        return $this;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            // Subscribe after route was resolved and request attributes were set
+            ConsoleCommandEvent::class => ['onCommand', 31],
+            ConsoleTerminateEvent::class => ['onTerminate'],
+        ];
+    }
+
+    public function onCommand(ConsoleCommandEvent $event): void
+    {
+        if (null === $command = $event->getCommand()) {
+            return;
+        }
+
+        $this->name = (string)$command->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/ControllerNameGenerator.php b/src/Name/Generator/ControllerNameGenerator.php
@@ -0,0 +1,37 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Symfony\Name\Generator;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+
+class ControllerNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+{
+    private string $controller = '';
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            // Subscribe after route was resolved and request attributes were set
+            RequestEvent::class => ['onRequest', 31],
+            TerminateEvent::class => ['onTerminate', -16384],
+        ];
+    }
+
+    public function onRequest(RequestEvent $event): void
+    {
+        $this->controller = (string)$event->getRequest()->attributes->get('_controller', '');
+    }
+
+    public function onTerminate(): void
+    {
+        $this->controller = '';
+    }
+
+    public function generate(): string
+    {
+        return $this->controller;
+    }
+}
diff --git a/src/Name/Generator/DefaultNameGenerator.php b/src/Name/Generator/DefaultNameGenerator.php
diff --git a/src/Name/Generator/NameGeneratorChain.php b/src/Name/Generator/NameGeneratorChain.php
diff --git a/src/Name/Generator/RequestNameGenerator.php b/src/Name/Generator/RequestNameGenerator.php
diff --git a/src/Name/Generator/ShortenGeneratorDecorator.php b/src/Name/Generator/ShortenGeneratorDecorator.php
diff --git a/src/Resources/services.yml b/src/Resources/services.yml
diff --git a/src/Resources/shorten.yml b/src/Resources/shorten.yml

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`}`
`8`	`8`	`},`
`9`	`9`	`"require": {`
`10`		`- "php": ">=7.1",`
	`10`	`+ "php": ">=7.4",`
`11`	`11`	`"code-tool/jaeger-client-php": "^3.1",`
`12`	`12`	`"symfony/config": "^4.3\|^5.0",`
`13`	`13`	`"symfony/console": "^4.3\|^5.0",`
Original file line number	Diff line number	Diff line change
`@@ -10,29 +10,29 @@`
`10`	`10`
`11`	`11`	`class GlobalSpanListener implements EventSubscriberInterface`
`12`	`12`	`{`
`13`		`- private $handler;`
	`13`	`+ private GlobalSpanHandler $handler;`
`14`	`14`
`15`	`15`	`public function __construct(GlobalSpanHandler $handler)`
`16`	`16`	`{`
`17`	`17`	`$this->handler = $handler;`
`18`	`18`	`}`
`19`	`19`
`20`		`- public static function getSubscribedEvents()`
	`20`	`+ public static function getSubscribedEvents(): array`
`21`	`21`	`{`
`22`	`22`	`return [`
`23`	`23`	`RequestEvent::class => ['onRequest', 30],`
`24`	`24`	`TerminateEvent::class => ['onTerminate', 4096],`
`25`	`25`	`];`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function onTerminate()`
	`28`	`+ public function onTerminate(): GlobalSpanListener`
`29`	`29`	`{`
`30`	`30`	`$this->handler->finish();`
`31`	`31`
`32`	`32`	`return $this;`
`33`	`33`	`}`
`34`	`34`
`35`		`- public function onRequest(RequestEvent $event)`
	`35`	`+ public function onRequest(RequestEvent $event): GlobalSpanListener`
`36`	`36`	`{`
`37`	`37`	`if (false === $this->isMainRequestEvent($event)) {`
`38`	`38`	`return $this;`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,9 @@ public function __construct(BackgroundSpanHandler $backgroundHandler, GlobalSpan`
`18`	`18`	`$this->globalHandler = $globalHandler;`
`19`	`19`	`}`
`20`	`20`
`21`		`- public static function getSubscribedEvents()`
	`21`	`+ public static function getSubscribedEvents(): array`
`22`	`22`	`{`
`23`		`- return [TerminateEvent::class => ['onTerminate', -16384],];`
	`23`	`+ return [TerminateEvent::class => ['onTerminate', -16384]];`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public function onTerminate()`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,10 @@ public function extract(): ?SpanContext`
`25`	`25`	`{`
`26`	`26`	`$queue = clone $this->queue;`
`27`	`27`	`while (false === $queue->isEmpty()) {`
`28`		`- if (null !== ($context = $queue->extract()->extract())) {`
	`28`	`+ /** @var ContextExtractorInterface $extractor */`
	`29`	`+ $extractor = $queue->extract();`
	`30`	`+ $context = $extractor->extract();`
	`31`	`+ if (null !== $context) {`
`29`	`32`	`return $context;`
`30`	`33`	`}`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,10 @@ public function getDebug(): string`
`23`	`23`	`{`
`24`	`24`	`$queue = clone $this->queue;`
`25`	`25`	`while (false === $queue->isEmpty()) {`
`26`		`- if ('' !== ($debugId = $queue->extract()->getDebug())) {`
	`26`	`+ /** @var DebugExtractorInterface $extractor */`
	`27`	`+ $extractor = $queue->extract();`
	`28`	`+ $debugId = $extractor->getDebug();`
	`29`	`+ if ('' !== $debugId) {`
`27`	`30`	`return $debugId;`
`28`	`31`	`}`
`29`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`class CodecRegistryCompilerPass implements CompilerPassInterface`
`11`	`11`	`{`
`12`		`- public function process(ContainerBuilder $container)`
	`12`	`+ public function process(ContainerBuilder $container): void`
`13`	`13`	`{`
`14`	`14`	`if (false === $container->hasDefinition('jaeger.codec.registry')) {`
`15`	`15`	`throw new \RuntimeException(`