UPGRADE-4.0.md

Upgrade 3.x to 4.0

• Bumped the required version of sentry/sentry to ^3.0: this version relies on the envelope endpoint; if you are using an on-premise installation it requires Sentry version >= v20.6.0 to work; if you are using sentry.io nothing will change and no action is needed. For further details read the UPGRADE-3.0.md document of sentry/sentry.

• Added the $hub argument to the constructor of the SubRequestListener class.

• Renamed the ConsoleListener class to ConsoleCommandListener.

• Renamed the ConsoleListener::onConsoleCommand method to ConsoleCommandListener::handleConsoleCommandEvent.

• Renamed the ErrorListener::onException method to ErrorListener::handleExceptionEvent.

• Removed the ErrorListener::onKernelException method.

• Removed the ErrorListener::onConsoleError method.

• Renamed the RequestListener::onKernelRequest method to RequestListener::handleKernelRequestEvent.

• Renamed the RequestListener::onKernelController method to RequestListener::handleKernelControllerEvent.

• Renamed the SubRequestListener::onKernelRequest method to SubRequestListener::handleKernelRequestEvent.

• Renamed the SubRequestListener::onKernelFinishRequest method to SubRequestListener::handleKernelFinishRequestEvent.

• Removed the Sentry\FlushableClientInterface service alias.

• Removed the sentry.listener_priorities configuration option.

  Before:

  sentry:
      listener_priorities:
          request: 10

  After:

  use Sentry\SentryBundle\EventListener\RequestListener;
  use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  use Symfony\Component\DependencyInjection\ContainerBuilder;
  use Symfony\Component\HttpKernel\KernelEvents;
  
  final class ChangeSentryListenerPriorityPass implements CompilerPassInterface
  {
      public function process(ContainerBuilder $container)
      {
          $definition = $container->getDefinition(RequestListener::class);
          $definitionTags = $definition->getTags();
  
          foreach ($definitionTags['kernel.event_listener'] as &$tags) {
              if (KernelEvents::REQUEST === $tags['event']) {
                  $tags['priority'] = 10;
              }
          }
  
          $definition->setTags($definitionTags);
      }
  }

• Removed the sentry.options.excluded_exceptions configuration option.

  Before:

  sentry:
      options:
          excluded_exceptions:
              - RuntimeException

  After:

  sentry:
      options:
          integrations:
              - 'Sentry\Integration\IgnoreErrorsIntegration'
  
  services:
      Sentry\Integration\IgnoreErrorsIntegration:
          arguments:
              $options:
                  ignore_exceptions:
                      - RuntimeException

• Changed the priority of the ConsoleCommandListener::handleConsoleErrorEvent listener to -64.

• Changed the priority of the ConsoleCommandListener::::handleConsoleCommandEvent listener to 128.

• Changed the priority of the MessengerListener::handleWorkerMessageFailedEvent listener to 50.

• Changed the priority of the RequestListener::handleKernelRequestEvent listener to 5.

• Changed the priority of the RequestListener::handleKernelControllerEvent listener to 10.

• Changed the priority of the SubRequestListener::handleKernelRequestEvent listener to 3.

• Changed the priority of the SubRequestListener::handleKernelFinishRequestEvent listener to 5.

• Changed the type of the sentry.options.before_send configuration option from scalar to string. The value must always be the name of the container service to call without the @ prefix.

  Before

  sentry:
      options:
          before_send: '@app.sentry.before_send'

  sentry:
      options:
          before_send: 'App\Sentry\BeforeSend::__invoke'

  sentry:
      options:
          before_send: ['App\Sentry\BeforeSend', '__invoke']

  After

  sentry:
      options:
          before_send: 'app.sentry.before_send'

• Changed the type of the sentry.options.before_breadcrumb configuration option from scalar to string. The value must always be the name of the container service to call without the @ prefix.

  Before

  sentry:
      options:
          before_breadcrumb: '@app.sentry.before_breadcrumb'

  sentry:
      options:
          before_breadcrumb: 'App\Sentry\BeforeBreadcrumb::__invoke'

  sentry:
      options:
          before_breadcrumb: ['App\Sentry\BeforeBreadcrumb', '__invoke']

  After

  sentry:
      options:
          before_breadcrumb: 'app.sentry.before_breadcrumb'

• Changed the type of the sentry.options.class_serializers configuration option from an array of scalar values to an array of string values. The value must always be the name of the container service to call without the @ prefix.

  Before

  sentry:
      options:
          class_serializers:
              App\FooClass: '@app.sentry.foo_class_serializer'

  sentry:
      options:
          class_serializers:
              App\FooClass: 'App\Sentry\FooClassSerializer::__invoke'

  sentry:
      options:
          class_serializers:
              App\FooClass: ['App\Sentry\FooClassSerializer', 'invoke']

  After

  sentry:
      options:
          class_serializers:
              App\FooClass: 'app.sentry.foo_class_serializer'

• Changed the type of the sentry.options.integrations configuration option from an array of scalar values to an array of string values. The value must always be the name of the container service to call without the @ prefix.

  Before

  sentry:
      options:
          integrations:
              - '@app.sentry.foo_integration'

  After

  sentry:
      options:
          integrations:
              - 'app.sentry.foo_integration'

• Removed the ClientBuilderConfigurator class.

• Removed the SentryBundle::getSdkVersion() method.

• Removed the SentryBundle::getCurrentHub() method, use SentrySdk::getCurrentHub() instead.

• Removed the Sentry\ClientBuilderInterface and Sentry\Options services.

• Refactorized the ErrorTypesParser class and made it @internal.

• Removed the sentry.monolog configuration option.

  Before

  sentry:
      monolog:
          level: !php/const Monolog\Logger::ERROR
          bubble: false
          error_handler:
              enabled: true

  After

  services:
      Sentry\Monolog\Handler:
          arguments:
              $hub: '@Sentry\State\HubInterface'
              $level: !php/const Monolog\Logger::ERROR
              $bubble: false