feat(metrics): add metrics for symfony (#977)

Author: Litarnus

composer.json

@@ -15,7 +15,7 @@
         "php": "^7.2||^8.0",
         "guzzlehttp/psr7": "^2.1.1",
         "jean85/pretty-package-versions": "^1.5||^2.0",
-        "sentry/sentry": "^4.18",
+        "sentry/sentry": "^4.19",
         "symfony/cache-contracts": "^1.1||^2.4||^3.0",
         "symfony/config": "^4.4.20||^5.0.11||^6.0||^7.0||^8.0",
         "symfony/console": "^4.4.20||^5.0.11||^6.0||^7.0||^8.0",

src/EventListener/ConsoleListener.php

@@ -8,6 +8,7 @@
 use Sentry\EventHint;
 use Sentry\ExceptionMechanism;
 use Sentry\Logs\Logs;
+use Sentry\Metrics\TraceMetrics;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
@@ -73,6 +74,7 @@ public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
     {
         Logs::getInstance()->flush();
+        TraceMetrics::getInstance()->flush();
         $this->hub->popScope();
     }
 

src/EventListener/MetricsRequestListener.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\EventListener;
+
+use Sentry\Metrics\TraceMetrics;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+
+/**
+ * RequestListener for sentry metrics.
+ */
+class MetricsRequestListener
+{
+    /**
+     * Flushes all metrics on kernel termination.
+     *
+     * @param TerminateEvent $event
+     *
+     * @return void
+     */
+    public function handleKernelTerminateEvent(TerminateEvent $event)
+    {
+        TraceMetrics::getInstance()->flush();
+    }
+}

src/Resources/config/services.yaml

@@ -78,6 +78,10 @@ services:
     tags:
       - { name: kernel.event_listener, event: kernel.terminate, method: handleKernelTerminateEvent, priority: 10 }
 
+  Sentry\SentryBundle\EventListener\MetricsRequestListener:
+    tags:
+      - { name: kernel.event_listener, event: kernel.terminate, method: handleKernelTerminateEvent, priority: 10 }
+
   # Command
   Sentry\SentryBundle\Command\SentryTestCommand:
     arguments: ['@Sentry\State\HubInterface']

tests/End2End/App/Command/MetricsCommand.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+use function Sentry\trace_metrics;
+
+class MetricsCommand extends Command
+{
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        trace_metrics()->count('test-counter', 10);
+        trace_metrics()->gauge('test-gauge', 20.51);
+        trace_metrics()->distribution('test-distribution', 100.81);
+
+        return 0;
+    }
+}

tests/End2End/App/Controller/MetricsController.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Controller;
+
+use Symfony\Component\HttpFoundation\Response;
+
+use function Sentry\trace_metrics;
+
+class MetricsController
+{
+    public function metrics(): Response
+    {
+        trace_metrics()->count('test-counter', 10);
+        trace_metrics()->gauge('test-gauge', 20.51);
+        trace_metrics()->distribution('test-distribution', 100.81);
+
+        return new Response();
+    }
+}

tests/End2End/App/KernelWithMetrics.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App;
+
+use Symfony\Component\Config\Loader\LoaderInterface;
+
+class KernelWithMetrics extends Kernel
+{
+    public function registerContainerConfiguration(LoaderInterface $loader): void
+    {
+        parent::registerContainerConfiguration($loader);
+
+        $loader->load(__DIR__ . '/metrics.yml');
+    }
+}

tests/End2End/App/metrics.yml

@@ -0,0 +1,9 @@
+services:
+  Sentry\SentryBundle\Tests\End2End\App\Controller\MetricsController:
+    autowire: true
+    tags:
+      - { name: controller.service_arguments }
+
+  Sentry\SentryBundle\Tests\End2End\App\Command\MetricsCommand:
+    autowire: true
+    tags: [ { name: 'console.command', command: 'metrics:test' } ]

tests/End2End/App/routing.yml

@@ -85,3 +85,7 @@ logging_before_send_logs:
 buffer_flush:
   path: /buffer-flush
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\BufferFlushController::testBufferFlush' }
+
+metrics:
+  path: /metrics
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MetricsController::metrics'}

tests/End2End/MetricsCommandTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End;
+
+use Sentry\SentryBundle\Tests\End2End\App\KernelWithMetrics;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Output\NullOutput;
+
+/**
+ * @runTestsInSeparateProcesses
+ */
+class MetricsCommandTest extends WebTestCase
+{
+    /**
+     * @var Application
+     */
+    private $application;
+
+    protected static function getKernelClass(): string
+    {
+        return KernelWithMetrics::class;
+    }
+
+    protected function setUp(): void
+    {
+        StubTransport::$events = [];
+        $this->application = new Application(self::bootKernel());
+    }
+
+    public function testMetricsInCommand(): void
+    {
+        $this->application->doRun(new ArgvInput(['bin/console', 'metrics:test']), new NullOutput());
+
+        $this->assertCount(1, StubTransport::$events);
+        $metrics = StubTransport::$events[0]->getMetrics();
+
+        $this->assertCount(3, $metrics);
+
+        $count = $metrics[0];
+        $this->assertSame('test-counter', $count->getName());
+        $this->assertSame(10.0, $count->getValue());
+
+        $gauge = $metrics[1];
+        $this->assertSame('test-gauge', $gauge->getName());
+        $this->assertSame(20.51, $gauge->getValue());
+
+        $distribution = $metrics[2];
+        $this->assertSame('test-distribution', $distribution->getName());
+        $this->assertSame(100.81, $distribution->getValue());
+    }
+}