vendor/sentry/sentry-symfony/src/EventListener/ConsoleListener.php line 49

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;
  12. use Symfony\Component\Console\Input\ArgvInput;
  14. /**
  15.  * This listener handles all errors thrown while running a console command and
  16.  * logs them to Sentry.
  17.  *
  18.  * @final since version 4.1
  19.  */
  20. class ConsoleListener
  21. {
  22.     /**
  23.      * @var HubInterface The current hub
  24.      */
  25.     private $hub;
  27.     /**
  28.      * @var bool Whether to capture console errors
  29.      */
  30.     private $captureErrors;
  32.     /**
  33.      * Constructor.
  34.      *
  35.      * @param HubInterface $hub           The current hub
  36.      * @param bool         $captureErrors Whether to capture console errors
  37.      */
  38.     public function __construct(HubInterface $hub, bool $captureErrors = true)
  39.     {
  40.         $this->hub = $hub;
  41.         $this->captureErrors = $captureErrors;
  42.     }
  44.     /**
  45.      * Handles the execution of a console command by pushing a new {@see Scope}.
  46.      *
  47.      * @param ConsoleCommandEvent $event The event
  48.      */
  49.     public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
  50.     {
  51.         $scope = $this->hub->pushScope();
  52.         $command = $event->getCommand();
  53.         $input = $event->getInput();
  55.         if (null !== $command && null !== $command->getName()) {
  56.             $scope->setTag('console.command', $command->getName());
  57.         }
  59.         if ($input instanceof ArgvInput) {
  60.             $scope->setExtra('Full command', (string) $input);
  61.         }
  62.     }
  64.     /**
  65.      * Handles the termination of a console command by popping the {@see Scope}.
  66.      *
  67.      * @param ConsoleTerminateEvent $event The event
  68.      */
  69.     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
  70.     {
  71.         $this->hub->popScope();
  72.     }
  74.     /**
  75.      * Handles an error that happened while running a console command.
  76.      *
  77.      * @param ConsoleErrorEvent $event The event
  78.      */
  79.     public function handleConsoleErrorEvent(ConsoleErrorEvent $event): void
  80.     {
  81.         $this->hub->configureScope(function (Scope $scope) use ($event): void {
  82.             $scope->setTag('console.command.exit_code', (string) $event->getExitCode());
  84.             if ($this->captureErrors) {
  85.                 $this->hub->captureException($event->getError());
  86.             }
  87.         });
  88.     }
  89. }