Add the IgnoreErrorsIntegration integration and deprecate the excluded_exceptions option

[ste93cry]

Q	A
Branch?	2.3
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
License	MIT

Closes #924. I decided that I didn't want to use the $payload argument of the capture* methods as an hacky way to pass options that configured the behavior of the method. Instead, like in the JS SDK I added a new integration that can be further expanded in the future and that will centralize all the logic to decide whether an event should be captured or not according to a set of criteria that must match with the event data. Being an integration means that the configuration now applies to all those methods and not only to the captureException one, so we cannot enable it by default until 3.0

[Jean85]

LGTM, apart from a small nitpick

[ste93cry]

I see that the Go SDK has a similar extension named IgnoreErrorsIntegration and I wonder if I should use the same name as it seems more appropriate and also clearer. Any opinion?

[Jean85]

👍 for that name, I like it

[stayallive]

👍

[VincentLanglet]

So we'll have to rename sentry.options.excluded_exceptions by sentry.options.ignore_exceptions ?

[ste93cry]

No, you can leave your code as is and it will keep working until 3.0. However, the excluded_exceptions option has been deprecated in favour of enabling the IgnoreErrorsIntegration integration that will be applied every time an event is captured, so it will work also when the Monolog handler is involved

[VincentLanglet]

so it will work also when the Monolog handler is involved

The excluded_Exceptions wasn't working for the Monolog handler (getsentry/sentry-symfony#273)

As soon as the 2.3 version is released, which of the following sentences is true ?

• The excluded_exceptions will work also for the Monolog handler
• We'll have to enabling the IgnoreErrorsIntegration if we want to ignore exceptions for the Monolog handler (But how ? With a ignore_exceptions ?)
• Some development is necessary for sentry-symfony in order to handle the IgnoreErrorsIntegration.

Thanks !

[ste93cry]

The excluded_Exceptions wasn't working for the Monolog handler

This is the reason of this PR, to make such option work in all cases regardless of who is calling the Client::capture* methods. To do it, an integration has been created and once enabled it will affect all those methods (instead the excluded_exceptions was not affecting the Client::captureEvent method that was used by the Monolog handler): this is the reason we cannot enable it out-of-the-box until 3.0 or we risk of breaking existing applications. So, at the end of the story:

• The excluded_exceptions option is deprecated as of version 2.3 and will be removed in 3.0
• The IgnoreErrorsIntegration will take the place of the old option. To use it you will need to use the integrations option to instantiate the class and pass to its constructor the values that you did pass to the excluded_exceptions. You can then stop using the deprecated option and everything should work as before except that this new integration will affect all the Client::capture* methods (and not only the captureError and captureException) and consequently the Monolog handler

Sentry\init([
-    excluded_exceptions => [
-        Exception::class,
-    ],
+    integrations => [
+        new Sentry\Integration\IgnoreErrorsIntegration([
+            Exception::class,
+        ]),
+    ],
]);