ref(metrics): add metric options

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.19",
+        "sentry/sentry": "^4.19.1",
         "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",

phpstan-baseline.neon

@@ -90,6 +90,11 @@ parameters:
 			count: 1
 			path: src/DependencyInjection/SentryExtension.php
 
+		-
+			message: "#^Cannot access offset 'before_send_metric' on mixed\\.$#"
+			count: 1
+			path: src/DependencyInjection/SentryExtension.php
+
 		-
 			message: "#^Parameter \\#1 \\$array of function array_filter expects array, mixed given\\.$#"
 			count: 1
@@ -102,7 +107,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\#1 \\$id of class Symfony\\\\Component\\\\DependencyInjection\\\\Reference constructor expects string, mixed given\\.$#"
-			count: 11
+			count: 12
 			path: src/DependencyInjection/SentryExtension.php
 
 		-

src/DependencyInjection/Configuration.php

@@ -89,6 +89,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->info('The sampling factor to apply to profiles. A value of 0 will deny sending any profiles, and a value of 1 will send all profiles. Profiles are sampled in relation to traces_sample_rate')
                         ->end()
                         ->booleanNode('enable_logs')->end()
+                        ->booleanNode('enable_metrics')->defaultTrue()->end()
                         ->booleanNode('attach_stacktrace')->end()
                         ->booleanNode('attach_metric_code_locations')->end()
                         ->integerNode('context_lines')->min(0)->end()
@@ -117,6 +118,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->scalarNode('before_send_check_in')->end()
                         ->scalarNode('before_send_metrics')->end()
                         ->scalarNode('before_send_log')->end()
+                        ->scalarNode('before_send_metric')->end()
                         ->variableNode('trace_propagation_targets')->end()
                         ->arrayNode('tags')
                             ->useAttributeAsKey('name')

src/DependencyInjection/SentryExtension.php

@@ -137,6 +137,10 @@ private function registerConfiguration(ContainerBuilder $container, array $confi
             $options['before_breadcrumb'] = new Reference($options['before_breadcrumb']);
         }
 
+        if (isset($options['before_send_metric'])) {
+            $options['before_send_metric'] = new Reference($options['before_send_metric']);
+        }
+
         if (isset($options['class_serializers'])) {
             $options['class_serializers'] = array_map(static function (string $value): Reference {
                 return new Reference($value);

tests/DependencyInjection/ConfigurationTest.php

@@ -27,6 +27,7 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
             'options' => [
                 'integrations' => [],
                 'prefixes' => array_merge(['%kernel.project_dir%'], array_filter(explode(\PATH_SEPARATOR, get_include_path() ?: ''))),
+                'enable_metrics' => true,
                 'environment' => '%kernel.environment%',
                 'release' => '%env(default::SENTRY_RELEASE)%',
                 'ignore_exceptions' => [],

tests/DependencyInjection/SentryExtensionTest.php

@@ -217,6 +217,7 @@ public function testClientIsCreatedFromOptions(): void
             'traces_sampler' => new Reference('App\\Sentry\\Tracing\\TracesSampler'),
             'profiles_sample_rate' => 1,
             'enable_logs' => true,
+            'enable_metrics' => true,
             'attach_stacktrace' => true,
             'attach_metric_code_locations' => true,
             'context_lines' => 0,

tests/End2End/App/KernelWithMetricsCallback.php

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

tests/End2End/App/KernelWithMetricsDisabled.php

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

tests/End2End/App/metrics_disabled.yml

@@ -0,0 +1,3 @@
+sentry:
+  options:
+    enable_metrics: false

tests/End2End/App/metrics_with_callback.yml

@@ -0,0 +1,12 @@
+sentry:
+  options:
+    before_send_metric: 'sentry.callback.before_send_metric'
+
+services:
+  Sentry\SentryBundle\Tests\End2End\Fixtures\SentryCallbacks:
+    class: 'Sentry\SentryBundle\Tests\End2End\Fixtures\SentryCallbacks'
+
+  sentry.callback.before_send_metric:
+    class: 'Sentry\SentryBundle\Tests\End2End\Fixtures\SentryCallbacks'
+    factory: ['@Sentry\SentryBundle\Tests\End2End\Fixtures\SentryCallbacks', 'getBeforeSendMetric']
+

tests/End2End/Fixtures/SentryCallbacks.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\Fixtures;
+
+use Sentry\Metrics\Types\Metric;
+
+class SentryCallbacks
+{
+    public static function getBeforeSendMetric(): callable
+    {
+        return static function (Metric $metric): ?Metric {
+            if ('test-counter' === $metric->getName()) {
+                return null;
+            }
+
+            return $metric;
+        };
+    }
+}

tests/End2End/MetricsCommandTest.php

@@ -42,7 +42,7 @@ public function testMetricsInCommand(): void
 
         $count = $metrics[0];
         $this->assertSame('test-counter', $count->getName());
-        $this->assertSame(10.0, $count->getValue());
+        $this->assertSame(10, $count->getValue());
 
         $gauge = $metrics[1];
         $this->assertSame('test-gauge', $gauge->getName());

tests/End2End/MetricsDisabledEnd2EndTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End;
+
+use Sentry\SentryBundle\Tests\End2End\App\KernelWithMetricsDisabled;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/**
+ * @runTestsInSeparateProcesses
+ */
+class MetricsDisabledEnd2EndTest extends WebTestCase
+{
+    protected function setUp(): void
+    {
+        StubTransport::$events = [];
+    }
+
+    protected static function getKernelClass(): string
+    {
+        return KernelWithMetricsDisabled::class;
+    }
+
+    public function testMetricsAreFlushedAfterRequest(): void
+    {
+        $client = static::createClient();
+
+        $client->request('GET', '/metrics');
+        $this->assertSame(200, $client->getResponse()->getStatusCode());
+
+        $this->assertEmpty(StubTransport::$events);
+    }
+}

tests/End2End/MetricsEnd2EndTest.php

@@ -35,7 +35,7 @@ public function testMetricsAreFlushedAfterRequest(): void
 
         $count = $metrics[0];
         $this->assertSame('test-counter', $count->getName());
-        $this->assertSame(10.0, $count->getValue());
+        $this->assertSame(10, $count->getValue());
 
         $gauge = $metrics[1];
         $this->assertSame('test-gauge', $gauge->getName());

tests/End2End/MetricsWithCallbackEnd2EndTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End;
+
+use Sentry\SentryBundle\Tests\End2End\App\KernelWithMetricsCallback;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/**
+ * @runTestsInSeparateProcesses
+ */
+class MetricsWithCallbackEnd2EndTest extends WebTestCase
+{
+    protected function setUp(): void
+    {
+        StubTransport::$events = [];
+    }
+
+    protected static function getKernelClass(): string
+    {
+        return KernelWithMetricsCallback::class;
+    }
+
+    public function testMetricsAreFlushedAfterRequest(): void
+    {
+        $client = static::createClient();
+
+        $client->request('GET', '/metrics');
+        $this->assertSame(200, $client->getResponse()->getStatusCode());
+
+        $this->assertCount(1, StubTransport::$events);
+
+        $metrics = StubTransport::$events[0]->getMetrics();
+        $this->assertCount(2, $metrics);
+
+        // Counter metric removed by `before_send_metric`
+        $gauge = $metrics[0];
+        $this->assertSame('test-gauge', $gauge->getName());
+        $this->assertSame(20.51, $gauge->getValue());
+
+        $distribution = $metrics[1];
+        $this->assertSame('test-distribution', $distribution->getName());
+        $this->assertSame(100.81, $distribution->getValue());
+    }
+}