feature #537 Deprecate sentry and raven handler types (GromNaN)

GromNaN · GromNaN · commit 2ebfbeec72fc · 2025-09-30T15:35:16.000+02:00
This PR was squashed before being merged into the 3.x branch. Discussion ---------- Deprecate `sentry` and `raven` handler types | Q | A | ------------- | --- | Branch? | 3.x | Bug fix? | no | New feature? | no | Deprecations? | yes | Issues | Fix #489 (comment) | License | MIT The upgrade path is to use a "service" handler with `sentry/sentry-symfony` as documented: https://docs.sentry.io/platforms/php/guides/symfony/logs/ Commits ------- 1902f5e Deprecate `sentry` and `raven` handler types
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 * Drop support for PHP < 8.1
 * Drop support for Symfony < 6.4
 * Add TelegramBotHandler `topic` support
+* Deprecate `sentry` and `raven` handler, use a `service` handler with [`sentry/sentry-symfony`](https://docs.sentry.io/platforms/php/guides/symfony/logs/) instead
 
 ## 3.10.0 (2023-11-06)
 
@@ -78,7 +79,7 @@
 
 ## 3.3.1 (2018-11-04)
 
-* Fixed compatiblity with Symfony 4.2
+* Fixed compatibility with Symfony 4.2
 
 ## 3.3.0 (2018-06-04)
 
diff --git a/composer.json b/composer.json
@@ -21,13 +21,14 @@
         "monolog/monolog": "^1.25.1 || ^2.0 || ^3.0",
         "symfony/config": "^6.4 || ^7.0",
         "symfony/dependency-injection": "^6.4 || ^7.0",
+        "symfony/deprecation-contracts": "^2.5 || ^3.0",
         "symfony/http-kernel": "^6.4 || ^7.0",
         "symfony/monolog-bridge": "^6.4 || ^7.0",
         "symfony/polyfill-php84": "^1.30"
     },
     "require-dev": {
         "symfony/console": "^6.4 || ^7.0",
-        "symfony/phpunit-bridge": "^7.1",
+        "symfony/phpunit-bridge": "^7.3.3",
         "symfony/yaml": "^6.4 || ^7.0"
     },
     "autoload": {
diff --git a/src/DependencyInjection/Compiler/DebugHandlerPass.php b/src/DependencyInjection/Compiler/DebugHandlerPass.php
@@ -31,7 +31,7 @@ class DebugHandlerPass implements CompilerPassInterface
 
     public function __construct(LoggerChannelPass $channelPass)
     {
-        @trigger_error('The '.__CLASS__.' class is deprecated since version 2.12 and will be removed in 4.0. Use AddDebugLogProcessorPass in FrameworkBundle instead.', \E_USER_DEPRECATED);
+        trigger_deprecation('symfony/monolog-bundle', '2.12', 'The %s class is deprecated and will be removed in 4.0. Use AddDebugLogProcessorPass in FrameworkBundle instead.', __CLASS__);
 
         $this->channelPass = $channelPass;
     }
diff --git a/src/DependencyInjection/MonologExtension.php b/src/DependencyInjection/MonologExtension.php
@@ -272,7 +272,7 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
                 break;
 
             case 'elasticsearch':
-                @trigger_error('The "elasticsearch" handler type is deprecated in MonologBundle since version 3.8.0, use the "elastica" type instead, or switch to the official Elastic client using the "elastic_search" type.', \E_USER_DEPRECATED);
+                trigger_deprecation('symfony/monolog-bundle', '3.8', 'The "elasticsearch" handler type is deprecated in MonologBundle since version 3.8.0, use the "elastica" type instead, or switch to the official Elastic client using the "elastic_search" type.');
                 // no break
 
             case 'elastica':
@@ -413,7 +413,7 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
                     $activation = new Reference($handler['activation_strategy']);
                 } elseif (!empty($handler['excluded_404s'])) {
                     if (class_exists(HttpCodeActivationStrategy::class)) {
-                        @trigger_error('The "excluded_404s" option is deprecated in MonologBundle since version 3.4.0, you should rely on the "excluded_http_codes" option instead.', \E_USER_DEPRECATED);
+                        trigger_deprecation('symfony/monolog-bundle', '3.4', 'The "excluded_404s" option is deprecated, you should rely on the "excluded_http_codes" option instead.');
                     }
                     $activationDef = new Definition('Symfony\Bridge\Monolog\Handler\FingersCrossed\NotFoundActivationStrategy', [
                         new Reference('request_stack'),
@@ -720,6 +720,7 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
                 break;
 
             case 'sentry':
+                trigger_deprecation('symfony/monolog-bundle', '3.11', 'The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
                 if (null !== $handler['hub_id']) {
                     $hubId = $handler['hub_id'];
                 } else {
@@ -771,6 +772,7 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
                 break;
 
             case 'raven':
+                trigger_deprecation('symfony/monolog-bundle', '3.11', 'The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
                 if (null !== $handler['client_id']) {
                     $clientId = $handler['client_id'];
                 } else {
diff --git a/tests/DependencyInjection/MonologExtensionTest.php b/tests/DependencyInjection/MonologExtensionTest.php
@@ -17,6 +17,7 @@
 use Monolog\Handler\RollbarHandler;
 use Monolog\Logger;
 use Monolog\Processor\UidProcessor;
+use Symfony\Bridge\PhpUnit\ExpectUserDeprecationMessageTrait;
 use Symfony\Bundle\MonologBundle\DependencyInjection\Compiler\LoggerChannelPass;
 use Symfony\Bundle\MonologBundle\DependencyInjection\MonologExtension;
 use Symfony\Bundle\MonologBundle\Tests\DependencyInjection\Fixtures\AsMonologProcessor\FooProcessor;
@@ -32,6 +33,8 @@
 
 class MonologExtensionTest extends DependencyInjectionTestCase
 {
+    use ExpectUserDeprecationMessageTrait;
+
     public function testLoadWithDefault()
     {
         $container = $this->getContainer([['handlers' => ['main' => ['type' => 'stream']]]]);
@@ -303,6 +306,7 @@ public function testRavenHandlerWhenConfigurationIsWrong()
         }
     }
 
+    /** @group legacy */
     public function testRavenHandlerWhenADSNIsSpecified()
     {
         if (Logger::API !== 1) {
@@ -311,6 +315,8 @@ public function testRavenHandlerWhenADSNIsSpecified()
             return;
         }
 
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $dsn = 'http://43f6017361224d098402974103bfc53d:a6a0538fc2934ba2bed32e08741b2cd3@marca.python.live.cheggnet.com:9000/1';
 
         $container = $this->getContainer([['handlers' => ['raven' => [
@@ -329,6 +335,7 @@ public function testRavenHandlerWhenADSNIsSpecified()
         $this->assertDICDefinitionClass($handler, 'Monolog\Handler\RavenHandler');
     }
 
+    /** @group legacy */
     public function testRavenHandlerWhenADSNAndAClientAreSpecified()
     {
         if (Logger::API !== 1) {
@@ -337,6 +344,8 @@ public function testRavenHandlerWhenADSNAndAClientAreSpecified()
             return;
         }
 
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $container = $this->getContainer([['handlers' => ['raven' => [
             'type' => 'raven', 'dsn' => 'foobar', 'client_id' => 'raven.client',
         ]]]], ['raven.client' => new Definition('Raven_Client')]);
@@ -349,6 +358,7 @@ public function testRavenHandlerWhenADSNAndAClientAreSpecified()
         $this->assertDICConstructorArguments($handler, [new Reference('raven.client'), 'DEBUG', true]);
     }
 
+    /** @group legacy */
     public function testRavenHandlerWhenAClientIsSpecified()
     {
         if (Logger::API !== 1) {
@@ -357,6 +367,8 @@ public function testRavenHandlerWhenAClientIsSpecified()
             return;
         }
 
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $container = $this->getContainer([['handlers' => ['raven' => [
             'type' => 'raven', 'client_id' => 'raven.client',
         ]]]], ['raven.client' => new Definition('Raven_Client')]);
@@ -377,8 +389,11 @@ public function testSentryHandlerWhenConfigurationIsWrong()
         $this->getContainer([['handlers' => ['sentry' => ['type' => 'sentry']]]]);
     }
 
+    /** @group legacy */
     public function testSentryHandlerWhenADSNIsSpecified()
     {
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $dsn = 'http://43f6017361224d098402974103bfc53d:a6a0538fc2934ba2bed32e08741b2cd3@marca.python.live.cheggnet.com:9000/1';
 
         $container = $this->getContainer([['handlers' => ['sentry' => [
@@ -401,8 +416,11 @@ public function testSentryHandlerWhenADSNIsSpecified()
         $this->assertDICConstructorArguments($hub, [new Reference('monolog.sentry.client.'.sha1($dsn))]);
     }
 
+    /** @group legacy */
     public function testSentryHandlerWhenADSNAndAClientAreSpecified()
     {
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $container = $this->getContainer(
             [
                 [
@@ -433,8 +451,11 @@ public function testSentryHandlerWhenADSNAndAClientAreSpecified()
         $this->assertDICConstructorArguments($hub, [new Reference('sentry.client')]);
     }
 
+    /** @group legacy */
     public function testSentryHandlerWhenAClientIsSpecified()
     {
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $container = $this->getContainer(
             [
                 [
@@ -464,8 +485,11 @@ public function testSentryHandlerWhenAClientIsSpecified()
         $this->assertDICConstructorArguments($hub, [new Reference('sentry.client')]);
     }
 
+    /** @group legacy */
     public function testSentryHandlerWhenAHubIsSpecified()
     {
+        $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');
+
         $container = $this->getContainer(
             [
                 [

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class DebugHandlerPass implements CompilerPassInterface`
`31`	`31`
`32`	`32`	`public function __construct(LoggerChannelPass $channelPass)`
`33`	`33`	`{`
`34`		`- @trigger_error('The '.__CLASS__.' class is deprecated since version 2.12 and will be removed in 4.0. Use AddDebugLogProcessorPass in FrameworkBundle instead.', \E_USER_DEPRECATED);`
	`34`	`+ trigger_deprecation('symfony/monolog-bundle', '2.12', 'The %s class is deprecated and will be removed in 4.0. Use AddDebugLogProcessorPass in FrameworkBundle instead.', __CLASS__);`
`35`	`35`
`36`	`36`	`$this->channelPass = $channelPass;`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`use Monolog\Handler\RollbarHandler;`
`18`	`18`	`use Monolog\Logger;`
`19`	`19`	`use Monolog\Processor\UidProcessor;`
	`20`	`+use Symfony\Bridge\PhpUnit\ExpectUserDeprecationMessageTrait;`
`20`	`21`	`use Symfony\Bundle\MonologBundle\DependencyInjection\Compiler\LoggerChannelPass;`
`21`	`22`	`use Symfony\Bundle\MonologBundle\DependencyInjection\MonologExtension;`
`22`	`23`	`use Symfony\Bundle\MonologBundle\Tests\DependencyInjection\Fixtures\AsMonologProcessor\FooProcessor;`
`@@ -32,6 +33,8 @@`
`32`	`33`
`33`	`34`	`class MonologExtensionTest extends DependencyInjectionTestCase`
`34`	`35`	`{`
	`36`	`+ use ExpectUserDeprecationMessageTrait;`
	`37`	`+`
`35`	`38`	`public function testLoadWithDefault()`
`36`	`39`	`{`
`37`	`40`	`$container = $this->getContainer([['handlers' => ['main' => ['type' => 'stream']]]]);`
`@@ -303,6 +306,7 @@ public function testRavenHandlerWhenConfigurationIsWrong()`
`303`	`306`	`}`
`304`	`307`	`}`
`305`	`308`
	`309`	`+ /** @group legacy */`
`306`	`310`	`public function testRavenHandlerWhenADSNIsSpecified()`
`307`	`311`	`{`
`308`	`312`	`if (Logger::API !== 1) {`
`@@ -311,6 +315,8 @@ public function testRavenHandlerWhenADSNIsSpecified()`
`311`	`315`	`return;`
`312`	`316`	`}`
`313`	`317`
	`318`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`319`	`+`
`314`	`320`	`$dsn = 'http://43f6017361224d098402974103bfc53d:[email protected]:9000/1';`
`315`	`321`
`316`	`322`	`$container = $this->getContainer([['handlers' => ['raven' => [`
`@@ -329,6 +335,7 @@ public function testRavenHandlerWhenADSNIsSpecified()`
`329`	`335`	`$this->assertDICDefinitionClass($handler, 'Monolog\Handler\RavenHandler');`
`330`	`336`	`}`
`331`	`337`
	`338`	`+ /** @group legacy */`
`332`	`339`	`public function testRavenHandlerWhenADSNAndAClientAreSpecified()`
`333`	`340`	`{`
`334`	`341`	`if (Logger::API !== 1) {`
`@@ -337,6 +344,8 @@ public function testRavenHandlerWhenADSNAndAClientAreSpecified()`
`337`	`344`	`return;`
`338`	`345`	`}`
`339`	`346`
	`347`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`348`	`+`
`340`	`349`	`$container = $this->getContainer([['handlers' => ['raven' => [`
`341`	`350`	`'type' => 'raven', 'dsn' => 'foobar', 'client_id' => 'raven.client',`
`342`	`351`	`]]]], ['raven.client' => new Definition('Raven_Client')]);`
`@@ -349,6 +358,7 @@ public function testRavenHandlerWhenADSNAndAClientAreSpecified()`
`349`	`358`	`$this->assertDICConstructorArguments($handler, [new Reference('raven.client'), 'DEBUG', true]);`
`350`	`359`	`}`
`351`	`360`
	`361`	`+ /** @group legacy */`
`352`	`362`	`public function testRavenHandlerWhenAClientIsSpecified()`
`353`	`363`	`{`
`354`	`364`	`if (Logger::API !== 1) {`
`@@ -357,6 +367,8 @@ public function testRavenHandlerWhenAClientIsSpecified()`
`357`	`367`	`return;`
`358`	`368`	`}`
`359`	`369`
	`370`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "raven" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`371`	`+`
`360`	`372`	`$container = $this->getContainer([['handlers' => ['raven' => [`
`361`	`373`	`'type' => 'raven', 'client_id' => 'raven.client',`
`362`	`374`	`]]]], ['raven.client' => new Definition('Raven_Client')]);`
`@@ -377,8 +389,11 @@ public function testSentryHandlerWhenConfigurationIsWrong()`
`377`	`389`	`$this->getContainer([['handlers' => ['sentry' => ['type' => 'sentry']]]]);`
`378`	`390`	`}`
`379`	`391`
	`392`	`+ /** @group legacy */`
`380`	`393`	`public function testSentryHandlerWhenADSNIsSpecified()`
`381`	`394`	`{`
	`395`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`396`	`+`
`382`	`397`	`$dsn = 'http://43f6017361224d098402974103bfc53d:[email protected]:9000/1';`
`383`	`398`
`384`	`399`	`$container = $this->getContainer([['handlers' => ['sentry' => [`
`@@ -401,8 +416,11 @@ public function testSentryHandlerWhenADSNIsSpecified()`
`401`	`416`	`$this->assertDICConstructorArguments($hub, [new Reference('monolog.sentry.client.'.sha1($dsn))]);`
`402`	`417`	`}`
`403`	`418`
	`419`	`+ /** @group legacy */`
`404`	`420`	`public function testSentryHandlerWhenADSNAndAClientAreSpecified()`
`405`	`421`	`{`
	`422`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`423`	`+`
`406`	`424`	`$container = $this->getContainer(`
`407`	`425`	`[`
`408`	`426`	`[`
`@@ -433,8 +451,11 @@ public function testSentryHandlerWhenADSNAndAClientAreSpecified()`
`433`	`451`	`$this->assertDICConstructorArguments($hub, [new Reference('sentry.client')]);`
`434`	`452`	`}`
`435`	`453`
	`454`	`+ /** @group legacy */`
`436`	`455`	`public function testSentryHandlerWhenAClientIsSpecified()`
`437`	`456`	`{`
	`457`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`458`	`+`
`438`	`459`	`$container = $this->getContainer(`
`439`	`460`	`[`
`440`	`461`	`[`
`@@ -464,8 +485,11 @@ public function testSentryHandlerWhenAClientIsSpecified()`
`464`	`485`	`$this->assertDICConstructorArguments($hub, [new Reference('sentry.client')]);`
`465`	`486`	`}`
`466`	`487`
	`488`	`+ /** @group legacy */`
`467`	`489`	`public function testSentryHandlerWhenAHubIsSpecified()`
`468`	`490`	`{`
	`491`	`+ $this->expectDeprecation('Since symfony/monolog-bundle 3.11: The "sentry" handler type is deprecated, use the "sentry/sentry-symfony" and a "service" handler instead.');`
	`492`	`+`
`469`	`493`	`$container = $this->getContainer(`
`470`	`494`	`[`
`471`	`495`	`[`