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

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\State\HubInterface;
  8. use Sentry\Tracing\Span;
  9. use Sentry\Tracing\SpanContext;
  10. use Sentry\Tracing\SpanStatus;
  11. use Sentry\Tracing\Transaction;
  12. use Sentry\Tracing\TransactionContext;
  13. use Sentry\Tracing\TransactionSource;
  14. use Symfony\Component\Console\Command\Command;
  15. use Symfony\Component\Console\Event\ConsoleCommandEvent;
  16. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  18. /**
  19.  * This listener either starts a {@see Transaction} or a child {@see Span} when
  20.  * a console command is executed to allow measuring the application performances.
  21.  */
  22. final class TracingConsoleListener
  23. {
  24.     /**
  25.      * @var HubInterface The current hub
  26.      */
  27.     private $hub;
  29.     /**
  30.      * @var string[] The list of commands for which distributed tracing must be skipped
  31.      */
  32.     private $excludedCommands;
  34.     /**
  35.      * Constructor.
  36.      *
  37.      * @param HubInterface $hub              The current hub
  38.      * @param string[]     $excludedCommands The list of commands for which distributed tracing must be skipped
  39.      */
  40.     public function __construct(HubInterface $hub, array $excludedCommands = [])
  41.     {
  42.         $this->hub = $hub;
  43.         $this->excludedCommands = $excludedCommands;
  44.     }
  46.     /**
  47.      * Handles the execution of a console command by starting a new {@see Transaction}
  48.      * if it doesn't exists, or a child {@see Span} if it does.
  49.      *
  50.      * @param ConsoleCommandEvent $event The event
  51.      */
  52.     public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
  53.     {
  54.         $command = $event->getCommand();
  56.         if ($this->isCommandExcluded($command)) {
  57.             return;
  58.         }
  60.         $currentSpan = $this->hub->getSpan();
  62.         if (null === $currentSpan) {
  63.             $span = $this->hub->startTransaction(
  64.                 TransactionContext::make()
  65.                     ->setOp('console.command')
  66.                     ->setOrigin('auto.console')
  67.                     ->setName($this->getSpanName($command))
  68.                     ->setSource(TransactionSource::task())
  69.             );
  70.         } else {
  71.             $span = $currentSpan->startChild(
  72.                 SpanContext::make()
  73.                     ->setOp('console.command')
  74.                     ->setOrigin('auto.console')
  75.                     ->setDescription($this->getSpanName($command))
  76.             );
  77.         }
  79.         $this->hub->setSpan($span);
  80.     }
  82.     /**
  83.      * Handles the termination of a console command by stopping the active {@see Span}
  84.      * or {@see Transaction}.
  85.      *
  86.      * @param ConsoleTerminateEvent $event The event
  87.      */
  88.     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
  89.     {
  90.         if ($this->isCommandExcluded($event->getCommand())) {
  91.             return;
  92.         }
  94.         $span = $this->hub->getSpan();
  96.         if (null !== $span) {
  97.             $span->setStatus(0 === $event->getExitCode() ? SpanStatus::ok() : SpanStatus::internalError());
  98.             $span->finish();
  99.         }
  100.     }
  102.     private function getSpanName(?Command $command): string
  103.     {
  104.         if (null === $command || null === $command->getName()) {
  105.             return '<unnamed command>';
  106.         }
  108.         return $command->getName();
  109.     }
  111.     private function isCommandExcluded(?Command $command): bool
  112.     {
  113.         if (null === $command) {
  114.             return true;
  115.         }
  117.         return \in_array($command->getName(), $this->excludedCommands, true);
  118.     }
  119. }