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

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