Adds ignore_exceptions and ignore_transactions options to Configurator

fixes: #710

Author: Gassan Gousseinov

src/DependencyInjection/Configuration.php

@@ -62,6 +62,8 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->fixXmlConfig('trace_propagation_target')
                     ->fixXmlConfig('tag')
                     ->fixXmlConfig('class_serializer')
+                    ->fixXmlConfig('ignore_exception')
+                    ->fixXmlConfig('ignore_transaction')
                     ->fixXmlConfig('prefix', 'prefixes')
                     ->children()
                         ->arrayNode('integrations')
@@ -157,6 +159,14 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->normalizeKeys(false)
                             ->scalarPrototype()->end()
                         ->end()
+                        ->arrayNode('ignore_exceptions')
+                            ->scalarPrototype()->end()
+                            ->beforeNormalization()->castToArray()->end()
+                        ->end()
+                        ->arrayNode('ignore_transactions')
+                            ->scalarPrototype()->end()
+                            ->beforeNormalization()->castToArray()->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end();

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

@@ -30,6 +30,8 @@
             <xsd:element name="in-app-exclude" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="in-app-include" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="class-serializer" type="class-serializer" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="ignore-exception" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="ignore-transaction" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
 
         <xsd:attribute name="default-integrations" type="xsd:boolean" />

tests/DependencyInjection/ConfigurationTest.php

@@ -39,6 +39,8 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
                 ],
                 'in_app_include' => [],
                 'class_serializers' => [],
+                'ignore_exceptions' => [],
+                'ignore_transactions' => [],
             ],
             'messenger' => [
                 'enabled' => interface_exists(MessageBusInterface::class),

tests/DependencyInjection/Fixtures/php/full.php

@@ -44,6 +44,8 @@
         'capture_silenced_errors' => true,
         'max_request_body_size' => 'none',
         'class_serializers' => ['App\\FooClass' => 'App\\Sentry\\Serializer\\FooClassSerializer'],
+        'ignore_exceptions' => ['Symfony\Component\HttpKernel\Exception\BadRequestHttpException'],
+        'ignore_transactions' => ['GET tracing_ignored_transaction'],
     ],
     'messenger' => [
         'enabled' => true,

tests/DependencyInjection/Fixtures/xml/full.xml

@@ -44,6 +44,8 @@
             <sentry:in-app-exclude>%kernel.cache_dir%</sentry:in-app-exclude>
             <sentry:in-app-include>%kernel.project_dir%</sentry:in-app-include>
             <sentry:class-serializer class="App\FooClass">App\Sentry\Serializer\FooClassSerializer</sentry:class-serializer>
+            <sentry:ignore-exception>Symfony\Component\HttpKernel\Exception\BadRequestHttpException</sentry:ignore-exception>
+            <sentry:ignore-transaction>GET tracing_ignored_transaction</sentry:ignore-transaction>
         </sentry:options>
         <sentry:messenger enabled="true" capture-soft-fails="false" />
         <sentry:tracing>

tests/DependencyInjection/Fixtures/yml/full.yml

@@ -42,6 +42,10 @@ sentry:
         max_request_body_size: 'none'
         class_serializers:
             App\FooClass: App\Sentry\Serializer\FooClassSerializer
+        ignore_exceptions:
+            - Symfony\Component\HttpKernel\Exception\BadRequestHttpException
+        ignore_transactions:
+            - GET tracing_ignored_transaction
     messenger:
         enabled: true
         capture_soft_fails: false

tests/DependencyInjection/SentryExtensionTest.php

@@ -233,6 +233,12 @@ public function testClientIsCreatedFromOptions(): void
                 'App\\FooClass' => new Reference('App\\Sentry\\Serializer\\FooClassSerializer'),
             ],
             'dsn' => 'https://[email protected]/0',
+            'ignore_exceptions' => [
+                'Symfony\Component\HttpKernel\Exception\BadRequestHttpException',
+            ],
+            'ignore_transactions' => [
+                'GET tracing_ignored_transaction',
+            ],
         ];
 
         $this->assertSame(Options::class, $optionsDefinition->getClass());

tests/End2End/App/Controller/MainController.php

@@ -8,6 +8,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
 class MainController
@@ -46,6 +47,11 @@ public function fatal(): Response
         return new Response('This response should not happen: ' . json_encode($foo));
     }
 
+    public function badRequest(): Response
+    {
+        throw new BadRequestHttpException('Parameter "foo" not allowed');
+    }
+
     public function index(): Response
     {
         $this->sentry->captureMessage('Hello there');

tests/End2End/App/Controller/TracingController.php

@@ -41,6 +41,16 @@ public function pingDatabase(): Response
         return new Response('Success');
     }
 
+    public function ignoredTransaction(): Response
+    {
+        $this->hub->setSpan(
+            $this->hub->getSpan()
+                ->startChild($this->createSpan())
+        );
+
+        return new Response('Success');
+    }
+
     private function createSpan(): SpanContext
     {
         $spanContext = new SpanContext();

tests/End2End/App/config.yml

@@ -6,6 +6,8 @@ sentry:
     capture_silenced_errors: false
     error_types: E_ALL & ~E_USER_DEPRECATED
     traces_sample_rate: 0
+    ignore_exceptions: 'Symfony\Component\HttpKernel\Exception\BadRequestHttpException'
+    ignore_transactions: 'GET tracing_ignored_transaction'
 
 framework:
   router: { resource: "%routing_config_dir%/routing.yml" }

tests/End2End/App/routing.yml

@@ -6,6 +6,10 @@ fatal:
   path:  /fatal
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MainController::fatal' }
 
+invalid_csrf:
+  path:  /bad-request
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MainController::badRequest' }
+
 success:
   path:  /200
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MainController::index' }
@@ -33,3 +37,7 @@ dispatch_unrecoverable:
 tracing_ping_database:
   path: /tracing/ping-database
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController::pingDatabase' }
+
+tracing_ignored_transaction:
+  path: /tracing/ignored-transaction
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController::ignoredTransaction' }

tests/End2End/End2EndTest.php

@@ -109,6 +109,20 @@ public function testGet404(): void
         $this->assertEventCount(1);
     }
 
+    public function testGetBadRequest(): void
+    {
+        $client = static::createClient(['debug' => false]);
+
+        $client->request('GET', '/bad-request');
+
+        $response = $client->getResponse();
+
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertSame(400, $response->getStatusCode());
+
+        $this->assertLastEventIdIsNull($client);
+    }
+
     public function testGet500(): void
     {
         $client = static::createClient();

tests/End2End/TracingEnd2EndTest.php

@@ -46,6 +46,21 @@ public function testTracingWithDoctrineConnectionPing(): void
         $this->assertTracingEventCount(1);
     }
 
+    public function testTracingWithIgnoredTransaction(): void
+    {
+        $client = static::createClient(['debug' => false]);
+
+        $client->request('GET', '/tracing/ignored-transaction');
+
+        $response = $client->getResponse();
+
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertSame(200, $response->getStatusCode());
+
+        $this->assertLastEventIdIsNull($client);
+        $this->assertTracingEventCount(1);
+    }
+
     private function assertLastEventIdIsNotNull(KernelBrowser $client): void
     {
         $container = $client->getContainer();
@@ -57,6 +72,17 @@ private function assertLastEventIdIsNotNull(KernelBrowser $client): void
         $this->assertNotNull($hub->getLastEventId(), 'Last error not captured');
     }
 
+    private function assertLastEventIdIsNull(KernelBrowser $client): void
+    {
+        $container = $client->getContainer();
+        $this->assertNotNull($container);
+
+        $hub = $container->get('test.hub');
+        $this->assertInstanceOf(HubInterface::class, $hub);
+
+        $this->assertNull($hub->getLastEventId(), 'Some error was captured');
+    }
+
     private function assertTracingEventCount(int $expectedCount): void
     {
         $events = file_get_contents(self::SENT_EVENTS_LOG);