feat(Instrumentation/Metrics): flush metrics on Console & Kernel TERMINATE events

Author: gaelreyrol

.editorconfig-checker.json

@@ -9,7 +9,7 @@
         "package.json",
         "package-lock.json",
         "composer.lock",
-        "tests/Functional/DummyMeterServiceTest.php"
+        "tests/*"
     ],
     "AllowedContentTypes": [],
     "PassedFiles": [],

composer.json

@@ -51,7 +51,7 @@
         "doctrine/doctrine-migrations-bundle": "^3.4",
         "doctrine/orm": "^2.18 || ^3.3",
         "ergebnis/composer-normalize": "^2.45",
-        "matthiasnoback/symfony-config-test": "^5.2",
+        "matthiasnoback/symfony-config-test": "^6.0",
         "matthiasnoback/symfony-dependency-injection-test": "^6.0",
         "mcaskill/composer-exclude-files": "^4.0",
         "nyholm/symfony-bundle-test": "^3.0",
@@ -74,7 +74,7 @@
         "symfony/twig-bundle": "^7.2",
         "symfony/yaml": "^7.2",
         "twig/twig": "^3.18",
-        "zalas/phpunit-globals": "^3.5"
+        "zalas/phpunit-globals": "^4.0"
     },
     "suggest": {
         "doctrine/doctrine-bundle": "Needed to enable Doctrine DBAL & ORM instrumentation",

src/DependencyInjection/OpenTelemetryExtension.php

@@ -43,6 +43,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $loader->load('services_metrics.php');
         $loader->load('services_traces.php');
         $loader->load('services_tracing_instrumentation.php');
+        $loader->load('services_metering_instrumentation.php');
 
         $this->registerService($mergedConfig['service'], $container);
         $this->registerInstrumentation($mergedConfig['instrumentation'], $container);
@@ -91,10 +92,16 @@ private function registerService(array $config, ContainerBuilder $container): vo
     private function registerInstrumentation(array $config, ContainerBuilder $container): void
     {
         $this->registerCacheTracingInstrumentationConfiguration($container, $config['cache']);
+
         $this->registerConsoleTracingInstrumentationConfiguration($container, $config['console']);
+        $this->registerConsoleMeteringInstrumentationConfiguration($container, $config['console']);
+
         $this->registerDoctrineTracingInstrumentationConfiguration($container, $config['doctrine']);
         $this->registerHttpClientTracingInstrumentationConfiguration($container, $config['http_client']);
+
         $this->registerHttpKernelTracingInstrumentationConfiguration($container, $config['http_kernel']);
+        $this->registerHttpKernelMeteringInstrumentationConfiguration($container, $config['http_kernel']);
+
         $this->registerMailerTracingInstrumentationConfiguration($container, $config['mailer']);
         $this->registerMessengerTracingInstrumentationConfiguration($container, $config['messenger']);
         $this->registerTwigTracingInstrumentationConfiguration($container, $config['twig']);
@@ -137,6 +144,22 @@ private function registerConsoleTracingInstrumentationConfiguration(ContainerBui
         $this->setTracingInstrumentationParams($container, 'console', $config, $isConfigEnabled);
     }
 
+    /**
+     * @param InstrumentationConfig $config
+     */
+    private function registerConsoleMeteringInstrumentationConfiguration(ContainerBuilder $container, array $config): void
+    {
+        $isConfigEnabled = $this->isConfigEnabled($container, $config['metering']);
+
+        if ($isConfigEnabled && !class_exists(Command::class)) {
+            throw new \LogicException('Console instrumentation cannot be enabled because the symfony/console package is not installed.');
+        }
+
+        if (!$isConfigEnabled) {
+            $container->removeDefinition('open_telemetry.instrumentation.console.metric.event_subscriber');
+        }
+    }
+
     /**
      * @param InstrumentationConfig $config
      */
@@ -188,6 +211,18 @@ private function registerHttpKernelTracingInstrumentationConfiguration(Container
         $this->setTracingInstrumentationParams($container, 'http_kernel', $config, $isConfigEnabled);
     }
 
+    /**
+     * @param InstrumentationConfig $config
+     */
+    private function registerHttpKernelMeteringInstrumentationConfiguration(ContainerBuilder $container, array $config): void
+    {
+        $isConfigEnabled = $this->isConfigEnabled($container, $config['metering']);
+
+        if (!$isConfigEnabled) {
+            $container->removeDefinition('open_telemetry.instrumentation.http_kernel.metric.event_subscriber');
+        }
+    }
+
     /**
      * @param InstrumentationConfig $config
      */

src/DependencyInjection/OpenTelemetryMetricsExtension.php

@@ -115,7 +115,9 @@ private function loadMetricProvider(string $name, array $config): void
                 isset($config['exporter']) ? new Reference($config['exporter']) : null,
                 $filter,
                 new Reference('open_telemetry.resource_info'),
-            ]);
+            ])
+            ->addTag('open_telemetry.metrics.provider')
+        ;
     }
 
     /**

src/Instrumentation/Symfony/Console/ObservableConsoleEventSubscriber.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace FriendsOfOpenTelemetry\OpenTelemetryBundle\Instrumentation\Symfony\Console;
+
+use OpenTelemetry\SDK\Metrics\MeterProviderInterface;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class ObservableConsoleEventSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        /**
+         * @var list<MeterProviderInterface>
+         */
+        private readonly iterable $locator,
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ConsoleEvents::TERMINATE => [
+                ['flush', -10000],
+            ],
+        ];
+    }
+
+    public function flush(ConsoleTerminateEvent $event): void
+    {
+        foreach ($this->locator as $provider) {
+            $provider->shutdown();
+        }
+    }
+}

src/Instrumentation/Symfony/Console/TraceableConsoleEventSubscriber.php

@@ -56,6 +56,11 @@ public static function getSubscribedEvents(): array
         ];
     }
 
+    public static function getSubscribedServices(): array
+    {
+        return [TracerInterface::class];
+    }
+
     public function startSpan(ConsoleCommandEvent $event): void
     {
         $command = $event->getCommand();
@@ -172,11 +177,6 @@ private function isAttributeTraceable(Command $command): bool
             && true === $traceable instanceof Traceable;
     }
 
-    public static function getSubscribedServices(): array
-    {
-        return [TracerInterface::class];
-    }
-
     public function setInstrumentationType(InstrumentationTypeEnum $type): void
     {
         $this->instrumentationType = $type;

src/Instrumentation/Symfony/HttpKernel/ObservableHttpKernelEventSubscriber.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace FriendsOfOpenTelemetry\OpenTelemetryBundle\Instrumentation\Symfony\HttpKernel;
+
+use OpenTelemetry\SDK\Metrics\MeterProviderInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+final class ObservableHttpKernelEventSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        /**
+         * @var list<MeterProviderInterface>
+         */
+        private readonly iterable $locator,
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::TERMINATE => [
+                ['flush', 10000],
+            ],
+        ];
+    }
+
+    public function flush(TerminateEvent $event): void
+    {
+        foreach ($this->locator as $provider) {
+            $provider->shutdown();
+        }
+    }
+}

src/Instrumentation/Symfony/HttpKernel/TraceableHttpKernelEventSubscriber.php

@@ -104,6 +104,11 @@ public static function getSubscribedEvents(): array
         ];
     }
 
+    public static function getSubscribedServices(): array
+    {
+        return [TracerInterface::class];
+    }
+
     public function startRequest(RequestEvent $event): void
     {
         $request = $event->getRequest();
@@ -393,11 +398,6 @@ private function createHeaderAttributeMapping(string $type, iterable $headers):
         return $headerAttributes;
     }
 
-    public static function getSubscribedServices(): array
-    {
-        return [TracerInterface::class];
-    }
-
     public function setInstrumentationType(InstrumentationTypeEnum $type): void
     {
         $this->instrumentationType = $type;

src/Resources/config/services_metering_instrumentation.php

@@ -0,0 +1,27 @@
+<?php
+
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\Instrumentation\Symfony\Console\ObservableConsoleEventSubscriber;
+use FriendsOfOpenTelemetry\OpenTelemetryBundle\Instrumentation\Symfony\HttpKernel\ObservableHttpKernelEventSubscriber;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_iterator;
+
+return static function (ContainerConfigurator $container): void {
+    $container->services()
+        ->defaults()
+        ->private()
+
+        // Console
+        ->set('open_telemetry.instrumentation.console.metric.event_subscriber', ObservableConsoleEventSubscriber::class)
+            ->args([tagged_iterator('open_telemetry.metrics.provider')])
+            ->tag('kernel.event_subscriber')
+            ->tag('monolog.logger', ['channel' => 'open_telemetry'])
+
+        // HTTP Kernel
+        ->set('open_telemetry.instrumentation.http_kernel.metric.event_subscriber', ObservableHttpKernelEventSubscriber::class)
+            ->args([tagged_iterator('open_telemetry.metrics.provider')])
+            ->tag('kernel.event_subscriber')
+            ->tag('monolog.logger', ['channel' => 'open_telemetry'])
+
+    ;
+};

src/Resources/config/services_tracing_instrumentation.php

@@ -37,6 +37,7 @@
         ->set('open_telemetry.instrumentation.console.trace.event_subscriber', TraceableConsoleEventSubscriber::class)
             ->arg('$tracer', service('open_telemetry.traces.default_tracer'))
             ->tag('kernel.event_subscriber')
+            ->tag('container.service_subscriber')
             ->tag('monolog.logger', ['channel' => 'open_telemetry'])
 
         // Doctrine
@@ -56,6 +57,7 @@
             ->arg('$propagator', service('open_telemetry.propagator_text_map.noop'))
             ->arg('$propagationGetter', service('open_telemetry.propagation_getter.headers'))
             ->tag('kernel.event_subscriber')
+            ->tag('container.service_subscriber')
             ->tag('monolog.logger', ['channel' => 'open_telemetry'])
 
         ->set('open_telemetry.instrumentation.http_kernel.trace.route_loader', TraceableRouteLoader::class)