feat: Add profiles_sample_rate (#698)

Author: cleptric

composer.json

@@ -26,7 +26,7 @@
         "php": "^7.2||^8.0",
         "jean85/pretty-package-versions": "^1.5 || ^2.0",
         "sentry/sdk": "^3.3",
-        "sentry/sentry": "^3.12",
+        "sentry/sentry": "^3.15",
         "symfony/cache-contracts": "^1.1||^2.4||^3.0",
         "symfony/config": "^4.4.20||^5.0.11||^6.0",
         "symfony/console": "^4.4.20||^5.0.11||^6.0",

phpstan-baseline.neon

@@ -260,6 +260,11 @@ parameters:
 			count: 1
 			path: src/Tracing/HttpClient/TraceableResponseForV6.php
 
+		-
+			message: "#^Cannot access offset 'profiles_sample_rate' on mixed\\.$#"
+			count: 1
+			path: tests/DependencyInjection/ConfigurationTest.php
+
 		-
 			message: "#^Cannot access offset 'sample_rate' on mixed\\.$#"
 			count: 1

src/DependencyInjection/Configuration.php

@@ -73,6 +73,11 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->max(1.0)
                             ->info('The sampling factor to apply to transactions. A value of 0 will deny sending any transaction, and a value of 1 will send all transactions.')
                         ->end()
+                        ->floatNode('profiles_sample_rate')
+                            ->min(0.0)
+                            ->max(1.0)
+                            ->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()
                         ->scalarNode('traces_sampler')->end()
                         ->arrayNode('trace_propagation_targets')
                             ->scalarPrototype()->end()

src/Resources/config/schema/sentry-1.0.xsd

@@ -36,6 +36,7 @@
         <xsd:attribute name="send-attempts" type="xsd:integer" />
         <xsd:attribute name="sample-rate" type="xsd:float" />
         <xsd:attribute name="traces-sample-rate" type="xsd:float" />
+        <xsd:attribute name="profiles-sample-rate" type="xsd:float" />
         <xsd:attribute name="traces-sampler" type="xsd:string" />
         <xsd:attribute name="attach-stacktrace" type="xsd:boolean" />
         <xsd:attribute name="context-lines" type="xsd:integer" />

tests/DependencyInjection/ConfigurationTest.php

@@ -195,6 +195,70 @@ public function tracesSampleRateOptionWithInvalidValuesDataProvider(): \Generato
         ];
     }
 
+    /**
+     * @param int|float $value
+     *
+     * @dataProvider profilesSampleRateOptionDataProvider
+     */
+    public function testProfilesSampleRateOption($value): void
+    {
+        $config = $this->processConfiguration(['options' => ['profiles_sample_rate' => $value]]);
+
+        $this->assertSame($value, $config['options']['profiles_sample_rate']);
+    }
+
+    /**
+     * @return \Generator<mixed>
+     */
+    public function profilesSampleRateOptionDataProvider(): \Generator
+    {
+        yield [0];
+        yield [1];
+        yield [0.0];
+        yield [1.0];
+        yield [0.01];
+        yield [0.9];
+    }
+
+    /**
+     * @param int|float $value
+     *
+     * @dataProvider profilesSampleRateOptionWithInvalidValuesDataProvider
+     */
+    public function testProfilesSampleRateOptionWithInvalidValues($value, string $exceptionMessage): void
+    {
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage($exceptionMessage);
+
+        $this->processConfiguration(['options' => ['profiles_sample_rate' => $value]]);
+    }
+
+    /**
+     * @return \Generator<mixed>
+     */
+    public function profilesSampleRateOptionWithInvalidValuesDataProvider(): \Generator
+    {
+        yield [
+            -1,
+            'The value -1 is too small for path "sentry.options.profiles_sample_rate". Should be greater than or equal to 0',
+        ];
+
+        yield [
+            2,
+            'The value 2 is too big for path "sentry.options.profiles_sample_rate". Should be less than or equal to 1',
+        ];
+
+        yield [
+            -0.1,
+            'The value -0.1 is too small for path "sentry.options.profiles_sample_rate". Should be greater than or equal to 0',
+        ];
+
+        yield [
+            1.01,
+            'The value 1.01 is too big for path "sentry.options.profiles_sample_rate". Should be less than or equal to 1',
+        ];
+    }
+
     /**
      * @param array<string, mixed> $values
      *

tests/DependencyInjection/Fixtures/php/full.php

@@ -16,6 +16,7 @@
         'prefixes' => ['%kernel.project_dir%'],
         'sample_rate' => 1,
         'traces_sample_rate' => 1,
+        'profiles_sample_rate' => 1,
         'traces_sampler' => 'App\\Sentry\\Tracing\\TracesSampler',
         'trace_propagation_targets' => ['website.invalid'],
         'attach_stacktrace' => true,

tests/DependencyInjection/Fixtures/xml/full.xml

@@ -15,6 +15,7 @@
                         send-attempts="1"
                         sample-rate="1"
                         traces-sample-rate="1"
+                        profiles-sample-rate="1"
                         traces-sampler="App\Sentry\Tracing\TracesSampler"
                         attach-stacktrace="true"
                         context-lines="0"

tests/DependencyInjection/Fixtures/yml/full.yml

@@ -11,6 +11,7 @@ sentry:
             - '%kernel.project_dir%'
         sample_rate: 1
         traces_sample_rate: 1
+        profiles_sample_rate: 1
         traces_sampler: App\Sentry\Tracing\TracesSampler
         trace_propagation_targets:
           - 'website.invalid'

tests/DependencyInjection/SentryExtensionTest.php

@@ -204,6 +204,7 @@ public function testClientIsCreatedFromOptions(): void
             'prefixes' => [$container->getParameter('kernel.project_dir')],
             'sample_rate' => 1,
             'traces_sample_rate' => 1,
+            'profiles_sample_rate' => 1,
             'traces_sampler' => new Reference('App\\Sentry\\Tracing\\TracesSampler'),
             'trace_propagation_targets' => ['website.invalid'],
             'attach_stacktrace' => true,