vendor/sentry/sentry/src/Tracing/Transaction.php line 144

  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\Tracing;
  7. use Sentry\Event;
  8. use Sentry\EventId;
  9. use Sentry\Profiling\Profiler;
  10. use Sentry\SentrySdk;
  11. use Sentry\State\HubInterface;
  13. /**
  14.  * This class stores all the information about a Transaction.
  15.  */
  16. final class Transaction extends Span
  17. {
  18.     /**
  19.      * @var HubInterface The hub instance
  20.      */
  21.     private $hub;
  23.     /**
  24.      * @var string Name of the transaction
  25.      */
  26.     private $name;
  28.     /**
  29.      * @var Transaction The transaction
  30.      */
  31.     protected $transaction;
  33.     /**
  34.      * @var TransactionMetadata
  35.      */
  36.     protected $metadata;
  38.     /**
  39.      * @var Profiler|null Reference instance to the {@see Profiler}
  40.      */
  41.     protected $profiler = null;
  43.     /**
  44.      * Span constructor.
  45.      *
  46.      * @param TransactionContext $context The context to create the transaction with
  47.      * @param HubInterface|null  $hub     Instance of a hub to flush the transaction
  48.      *
  49.      * @internal
  50.      */
  51.     public function __construct(TransactionContext $context, ?HubInterface $hub = null)
  52.     {
  53.         parent::__construct($context);
  55.         $this->hub = $hub ?? SentrySdk::getCurrentHub();
  56.         $this->name = $context->getName();
  57.         $this->metadata = $context->getMetadata();
  58.         $this->transaction = $this;
  59.     }
  61.     /**
  62.      * Gets the name of this transaction.
  63.      */
  64.     public function getName(): string
  65.     {
  66.         return $this->name;
  67.     }
  69.     /**
  70.      * Sets the name of this transaction.
  71.      *
  72.      * @param string $name The name
  73.      */
  74.     public function setName(string $name): void
  75.     {
  76.         $this->name = $name;
  77.     }
  79.     /**
  80.      * Gets the transaction metadata.
  81.      */
  82.     public function getMetadata(): TransactionMetadata
  83.     {
  84.         return $this->metadata;
  85.     }
  87.     /**
  88.      * Gets the transaction dynamic sampling context.
  89.      */
  90.     public function getDynamicSamplingContext(): DynamicSamplingContext
  91.     {
  92.         if (null !== $this->metadata->getDynamicSamplingContext()) {
  93.             return $this->metadata->getDynamicSamplingContext();
  94.         }
  96.         $samplingContext = DynamicSamplingContext::fromTransaction($this->transaction, $this->hub);
  97.         $this->getMetadata()->setDynamicSamplingContext($samplingContext);
  99.         return $samplingContext;
  100.     }
  102.     /**
  103.      * Attaches a {@see SpanRecorder} to the transaction itself.
  104.      *
  105.      * @param int $maxSpans The maximum number of spans that can be recorded
  106.      */
  107.     public function initSpanRecorder(int $maxSpans = 1000): void
  108.     {
  109.         if (null === $this->spanRecorder) {
  110.             $this->spanRecorder = new SpanRecorder($maxSpans);
  111.         }
  113.         $this->spanRecorder->add($this);
  114.     }
  116.     public function detachSpanRecorder(): void
  117.     {
  118.         $this->spanRecorder = null;
  119.     }
  121.     public function initProfiler(): void
  122.     {
  123.         if (null === $this->profiler) {
  124.             $client = $this->hub->getClient();
  125.             $options = null !== $client ? $client->getOptions() : null;
  127.             $this->profiler = new Profiler($options);
  128.         }
  129.     }
  131.     public function getProfiler(): ?Profiler
  132.     {
  133.         return $this->profiler;
  134.     }
  136.     public function detachProfiler(): void
  137.     {
  138.         $this->profiler = null;
  139.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      */
  144.     public function finish(?float $endTimestamp = null): ?EventId
  145.     {
  146.         if (null !== $this->profiler) {
  147.             $this->profiler->stop();
  148.         }
  150.         if (null !== $this->endTimestamp) {
  151.             // Transaction was already finished once and we don't want to re-flush it
  152.             return null;
  153.         }
  155.         parent::finish($endTimestamp);
  157.         if (true !== $this->sampled) {
  158.             return null;
  159.         }
  161.         $finishedSpans = [];
  163.         if (null !== $this->spanRecorder) {
  164.             foreach ($this->spanRecorder->getSpans() as $span) {
  165.                 if ($span->getSpanId() !== $this->getSpanId() && null !== $span->getEndTimestamp()) {
  166.                     $finishedSpans[] = $span;
  167.                 }
  168.             }
  169.         }
  171.         $event = Event::createTransaction();
  172.         $event->setSpans($finishedSpans);
  173.         $event->setStartTimestamp($this->startTimestamp);
  174.         $event->setTimestamp($this->endTimestamp);
  175.         $event->setTags($this->tags);
  176.         $event->setTransaction($this->name);
  177.         $event->setContext('trace', $this->getTraceContext());
  178.         $event->setSdkMetadata('dynamic_sampling_context', $this->getDynamicSamplingContext());
  179.         $event->setSdkMetadata('transaction_metadata', $this->getMetadata());
  181.         if (null !== $this->profiler) {
  182.             $profile = $this->profiler->getProfile();
  183.             if (null !== $profile) {
  184.                 $event->setSdkMetadata('profile', $profile);
  185.             }
  186.         }
  188.         return $this->hub->captureEvent($event);
  189.     }
  190. }