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

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.      * Constructor.
  29.      *
  30.      * @param HubInterface $hub The current hub
  31.      */
  32.     public function __construct(HubInterface $hub)
  33.     {
  34.         $this->hub = $hub;
  35.     }
  37.     /**
  38.      * Handles the execution of a console command by starting a new {@see Transaction}
  39.      * if it doesn't exists, or a child {@see Span} if it does.
  40.      *
  41.      * @param ConsoleCommandEvent $event The event
  42.      */
  43.     public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
  44.     {
  45.         $currentSpan = $this->hub->getSpan();
  47.         if (null === $currentSpan) {
  48.             $transactionContext = new TransactionContext();
  49.             $transactionContext->setOp('console.command');
  50.             $transactionContext->setName($this->getSpanName($event->getCommand()));
  52.             $span = $this->hub->startTransaction($transactionContext);
  53.         } else {
  54.             $spanContext = new SpanContext();
  55.             $spanContext->setOp('console.command');
  56.             $spanContext->setDescription($this->getSpanName($event->getCommand()));
  58.             $span = $currentSpan->startChild($spanContext);
  59.         }
  61.         $this->hub->setSpan($span);
  62.     }
  64.     /**
  65.      * Handles the termination of a console command by stopping the active {@see Span}
  66.      * or {@see Transaction}.
  67.      *
  68.      * @param ConsoleTerminateEvent $event The event
  69.      */
  70.     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
  71.     {
  72.         $span = $this->hub->getSpan();
  74.         if (null !== $span) {
  75.             $span->finish();
  76.         }
  77.     }
  79.     private function getSpanName(?Command $command): string
  80.     {
  81.         if (null === $command || null === $command->getName()) {
  82.             return '<unnamed command>';
  83.         }
  85.         return $command->getName();
  86.     }
  87. }