vendor/sentry/sentry-symfony/src/EventListener/ConsoleCommandListener.php line 46

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\State\HubInterface;
  8. use Sentry\State\Scope;
  9. use Symfony\Component\Console\Event\ConsoleCommandEvent;
  10. use Symfony\Component\Console\Event\ConsoleErrorEvent;
  11. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  13. /**
  14.  * This listener handles all errors thrown while running a console command and
  15.  * logs them to Sentry.
  16.  */
  17. final class ConsoleCommandListener
  18. {
  19.     /**
  20.      * @var HubInterface The current hub
  21.      */
  22.     private $hub;
  24.     /**
  25.      * @var bool Whether to capture console errors
  26.      */
  27.     private $captureErrors;
  29.     /**
  30.      * Constructor.
  31.      *
  32.      * @param HubInterface $hub           The current hub
  33.      * @param bool         $captureErrors Whether to capture console errors
  34.      */
  35.     public function __construct(HubInterface $hub, bool $captureErrors = true)
  36.     {
  37.         $this->hub = $hub;
  38.         $this->captureErrors = $captureErrors;
  39.     }
  41.     /**
  42.      * Handles the execution of a console command by pushing a new {@see Scope}.
  43.      *
  44.      * @param ConsoleCommandEvent $event The event
  45.      */
  46.     public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
  47.     {
  48.         $scope = $this->hub->pushScope();
  49.         $command = $event->getCommand();
  51.         if (null !== $command && null !== $command->getName()) {
  52.             $scope->setTag('console.command', $command->getName());
  53.         }
  54.     }
  56.     /**
  57.      * Handles the termination of a console command by popping the {@see Scope}.
  58.      *
  59.      * @param ConsoleTerminateEvent $event The event
  60.      */
  61.     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
  62.     {
  63.         $this->hub->popScope();
  64.     }
  66.     /**
  67.      * Handles an error that happened while running a console command.
  68.      *
  69.      * @param ConsoleErrorEvent $event The event
  70.      */
  71.     public function handleConsoleErrorEvent(ConsoleErrorEvent $event): void
  72.     {
  73.         $this->hub->configureScope(function (Scope $scope) use ($event): void {
  74.             $scope->setTag('console.command.exit_code', (string) $event->getExitCode());
  76.             if ($this->captureErrors) {
  77.                 $this->hub->captureException($event->getError());
  78.             }
  79.         });
  80.     }
  81. }