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

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