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

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\Transaction;
  11. use Sentry\Tracing\TransactionContext;
  12. use Symfony\Component\Console\Command\Command;
  13. use Symfony\Component\Console\Event\ConsoleCommandEvent;
  14. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  16. /**
  17.  * This listener either starts a {@see Transaction} or a child {@see Span} when
  18.  * a console command is executed to allow measuring the application performances.
  19.  */
  20. final class TracingConsoleListener
  21. {
  22.     /**
  23.      * @var HubInterface The current hub
  24.      */
  25.     private $hub;
  27.     /**
  28.      * @var string[] The list of commands for which distributed tracing must be skipped
  29.      */
  30.     private $excludedCommands;
  32.     /**
  33.      * Constructor.
  34.      *
  35.      * @param HubInterface $hub              The current hub
  36.      * @param string[]     $excludedCommands The list of commands for which distributed tracing must be skipped
  37.      */
  38.     public function __construct(HubInterface $hub, array $excludedCommands = [])
  39.     {
  40.         $this->hub = $hub;
  41.         $this->excludedCommands = $excludedCommands;
  42.     }
  44.     /**
  45.      * Handles the execution of a console command by starting a new {@see Transaction}
  46.      * if it doesn't exists, or a child {@see Span} if it does.
  47.      *
  48.      * @param ConsoleCommandEvent $event The event
  49.      */
  50.     public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
  51.     {
  52.         $command = $event->getCommand();
  54.         if ($this->isCommandExcluded($command)) {
  55.             return;
  56.         }
  58.         $currentSpan = $this->hub->getSpan();
  60.         if (null === $currentSpan) {
  61.             $transactionContext = new TransactionContext();
  62.             $transactionContext->setOp('console.command');
  63.             $transactionContext->setName($this->getSpanName($command));
  65.             $span = $this->hub->startTransaction($transactionContext);
  66.         } else {
  67.             $spanContext = new SpanContext();
  68.             $spanContext->setOp('console.command');
  69.             $spanContext->setDescription($this->getSpanName($command));
  71.             $span = $currentSpan->startChild($spanContext);
  72.         }
  74.         $this->hub->setSpan($span);
  75.     }
  77.     /**
  78.      * Handles the termination of a console command by stopping the active {@see Span}
  79.      * or {@see Transaction}.
  80.      *
  81.      * @param ConsoleTerminateEvent $event The event
  82.      */
  83.     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
  84.     {
  85.         if ($this->isCommandExcluded($event->getCommand())) {
  86.             return;
  87.         }
  89.         $span = $this->hub->getSpan();
  91.         if (null !== $span) {
  92.             $span->finish();
  93.         }
  94.     }
  96.     private function getSpanName(?Command $command): string
  97.     {
  98.         if (null === $command || null === $command->getName()) {
  99.             return '<unnamed command>';
  100.         }
  102.         return $command->getName();
  103.     }
  105.     private function isCommandExcluded(?Command $command): bool
  106.     {
  107.         if (null === $command) {
  108.             return true;
  109.         }
  111.         return \in_array($command->getName(), $this->excludedCommands, true);
  112.     }
  113. }