Viewing file:  Transaction.php (4.72 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
declare(strict_types=1);
namespace Sentry\Tracing;
use Sentry\Event;
use Sentry\EventId;
use Sentry\Profiling\Profiler;
use Sentry\SentrySdk;
use Sentry\State\HubInterface;
/**
* This class stores all the information about a Transaction.
*/
final class Transaction extends Span
{
/**
* @var HubInterface The hub instance
*/
private $hub;
/**
* @var string Name of the transaction
*/
private $name;
/**
* @var Transaction The transaction
*/
protected $transaction;
/**
* @var TransactionMetadata
*/
protected $metadata;
/**
* @var Profiler|null Reference instance to the {@see Profiler}
*/
protected $profiler = null;
/**
* Span constructor.
*
* @param TransactionContext $context The context to create the transaction with
* @param HubInterface|null $hub Instance of a hub to flush the transaction
*
* @internal
*/
public function __construct(TransactionContext $context, ?HubInterface $hub = null)
{
parent::__construct($context);
$this->hub = $hub ?? SentrySdk::getCurrentHub();
$this->name = $context->getName();
$this->metadata = $context->getMetadata();
$this->transaction = $this;
}
/**
* Gets the name of this transaction.
*/
public function getName(): string
{
return $this->name;
}
/**
* Sets the name of this transaction.
*
* @param string $name The name
*/
public function setName(string $name): void
{
$this->name = $name;
}
/**
* Gets the transaction metadata.
*/
public function getMetadata(): TransactionMetadata
{
return $this->metadata;
}
/**
* Gets the transaction dynamic sampling context.
*/
public function getDynamicSamplingContext(): DynamicSamplingContext
{
if (null !== $this->metadata->getDynamicSamplingContext()) {
return $this->metadata->getDynamicSamplingContext();
}
$samplingContext = DynamicSamplingContext::fromTransaction($this->transaction, $this->hub);
$this->getMetadata()->setDynamicSamplingContext($samplingContext);
return $samplingContext;
}
/**
* Attaches a {@see SpanRecorder} to the transaction itself.
*
* @param int $maxSpans The maximum number of spans that can be recorded
*/
public function initSpanRecorder(int $maxSpans = 1000): void
{
if (null === $this->spanRecorder) {
$this->spanRecorder = new SpanRecorder($maxSpans);
}
$this->spanRecorder->add($this);
}
public function detachSpanRecorder(): void
{
$this->spanRecorder = null;
}
public function initProfiler(): void
{
if (null === $this->profiler) {
$client = $this->hub->getClient();
$options = null !== $client ? $client->getOptions() : null;
$this->profiler = new Profiler($options);
}
}
public function getProfiler(): ?Profiler
{
return $this->profiler;
}
public function detachProfiler(): void
{
$this->profiler = null;
}
/**
* {@inheritdoc}
*/
public function finish(?float $endTimestamp = null): ?EventId
{
if (null !== $this->profiler) {
$this->profiler->stop();
}
if (null !== $this->endTimestamp) {
// Transaction was already finished once and we don't want to re-flush it
return null;
}
parent::finish($endTimestamp);
if (true !== $this->sampled) {
return null;
}
$finishedSpans = [];
if (null !== $this->spanRecorder) {
foreach ($this->spanRecorder->getSpans() as $span) {
if ($span->getSpanId() !== $this->getSpanId() && null !== $span->getEndTimestamp()) {
$finishedSpans[] = $span;
}
}
}
$event = Event::createTransaction();
$event->setSpans($finishedSpans);
$event->setStartTimestamp($this->startTimestamp);
$event->setTimestamp($this->endTimestamp);
$event->setTags($this->tags);
$event->setTransaction($this->name);
$event->setContext('trace', $this->getTraceContext());
$event->setSdkMetadata('dynamic_sampling_context', $this->getDynamicSamplingContext());
$event->setSdkMetadata('transaction_metadata', $this->getMetadata());
if (null !== $this->profiler) {
$profile = $this->profiler->getProfile();
if (null !== $profile) {
$event->setSdkMetadata('profile', $profile);
}
}
return $this->hub->captureEvent($event);
}
}
|