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

  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\Event;
  8. use Sentry\EventHint;
  9. use Sentry\ExceptionMechanism;
  10. use Sentry\State\HubInterface;
  11. use Sentry\State\Scope;
  12. use Symfony\Component\Console\Event\ConsoleCommandEvent;
  13. use Symfony\Component\Console\Event\ConsoleErrorEvent;
  14. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  15. use Symfony\Component\Console\Input\ArgvInput;
  17. /**
  18.  * This listener handles all errors thrown while running a console command and
  19.  * logs them to Sentry.
  20.  *
  21.  * @final since version 4.1
  22.  */
  23. class ConsoleListener
  24. {
  25.     /**
  26.      * @var HubInterface The current hub
  27.      */
  28.     private $hub;
  30.     /**
  31.      * @var bool Whether to capture console errors
  32.      */
  33.     private $captureErrors;
  35.     /**
  36.      * Constructor.
  37.      *
  38.      * @param HubInterface $hub           The current hub
  39.      * @param bool         $captureErrors Whether to capture console errors
  40.      */
  41.     public function __construct(HubInterface $hub, bool $captureErrors = true)
  42.     {
  43.         $this->hub = $hub;
  44.         $this->captureErrors = $captureErrors;
  45.     }
  47.     /**
  48.      * Handles the execution of a console command by pushing a new {@see Scope}.
  49.      *
  50.      * @param ConsoleCommandEvent $event The event
  51.      */
  52.     public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
  53.     {
  54.         $scope = $this->hub->pushScope();
  55.         $command = $event->getCommand();
  56.         $input = $event->getInput();
  58.         if (null !== $command && null !== $command->getName()) {
  59.             $scope->setTag('console.command', $command->getName());
  60.         }
  62.         if ($input instanceof ArgvInput) {
  63.             $scope->setExtra('Full command', (string) $input);
  64.         }
  65.     }
  67.     /**
  68.      * Handles the termination of a console command by popping the {@see Scope}.
  69.      *
  70.      * @param ConsoleTerminateEvent $event The event
  71.      */
  72.     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
  73.     {
  74.         $this->hub->popScope();
  75.     }
  77.     /**
  78.      * Handles an error that happened while running a console command.
  79.      *
  80.      * @param ConsoleErrorEvent $event The event
  81.      */
  82.     public function handleConsoleErrorEvent(ConsoleErrorEvent $event): void
  83.     {
  84.         $this->hub->configureScope(function (Scope $scope) use ($event): void {
  85.             $scope->setTag('console.command.exit_code', (string) $event->getExitCode());
  87.             if ($this->captureErrors) {
  88.                 $hint = EventHint::fromArray([
  89.                     'exception' => $event->getError(),
  90.                     'mechanism' => new ExceptionMechanism(ExceptionMechanism::TYPE_GENERIC, false),
  91.                 ]);
  93.                 $this->hub->captureEvent(Event::createEvent(), $hint);
  94.             }
  95.         });
  96.     }
  97. }