Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add TransactionContext::fromEnvironment #1519

Merged
merged 1 commit into from
Apr 24, 2023
Merged

feat: Add TransactionContext::fromEnvironment #1519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions src/Tracing/TransactionContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,18 +136,34 @@ public static function fromSentryTrace(string $header): self
return $context;
}

/**
* Returns a context populated with the data of the given environment variables.
*
* @param string $sentryTrace The sentry-trace value from the environment
* @param string $baggage The baggage header value from the environment
*/
public static function fromEnvironment(string $sentryTrace, string $baggage): self
{
return self::parseTraceAndBaggage($sentryTrace, $baggage);
}

/**
* Returns a context populated with the data of the given headers.
*
* @param string $sentryTraceHeader The sentry-trace header from an incoming request
* @param string $baggageHeader The baggage header from an incoming request
*/
public static function fromHeaders(string $sentryTraceHeader, string $baggageHeader): self
{
return self::parseTraceAndBaggage($sentryTraceHeader, $baggageHeader);
}

private static function parseTraceAndBaggage(string $sentryTrace, string $baggage): self
{
$context = new self();
$hasSentryTrace = false;

if (preg_match(self::TRACEPARENT_HEADER_REGEX, $sentryTraceHeader, $matches)) {
if (preg_match(self::TRACEPARENT_HEADER_REGEX, $sentryTrace, $matches)) {
if (!empty($matches['trace_id'])) {
$context->traceId = new TraceId($matches['trace_id']);
$hasSentryTrace = true;
Expand All @@ -164,7 +180,7 @@ public static function fromHeaders(string $sentryTraceHeader, string $baggageHea
}
}

$samplingContext = DynamicSamplingContext::fromHeader($baggageHeader);
$samplingContext = DynamicSamplingContext::fromHeader($baggage);

if ($hasSentryTrace && !$samplingContext->hasEntries()) {
// The request comes from an old SDK which does not support Dynamic Sampling.
Expand Down
18 changes: 16 additions & 2 deletions tests/Tracing/TransactionContextTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public function fromSentryTraceDataProvider(): iterable
}

/**
* @dataProvider fromHeadersDataProvider
* @dataProvider tracingDataProvider
*/
public function testFromHeaders(string $sentryTraceHeader, string $baggageHeader, ?SpanId $expectedSpanId, ?TraceId $expectedTraceId, ?bool $expectedParentSampled, ?string $expectedDynamicSamplingContextClass, ?bool $expectedDynamicSamplingContextFrozen)
{
Expand All @@ -103,7 +103,21 @@ public function testFromHeaders(string $sentryTraceHeader, string $baggageHeader
$this->assertSame($expectedDynamicSamplingContextFrozen, $spanContext->getMetadata()->getDynamicSamplingContext()->isFrozen());
}

public function fromHeadersDataProvider(): iterable
/**
* @dataProvider tracingDataProvider
*/
public function testFromEnvironment(string $sentryTrace, string $baggage, ?SpanId $expectedSpanId, ?TraceId $expectedTraceId, ?bool $expectedParentSampled, ?string $expectedDynamicSamplingContextClass, ?bool $expectedDynamicSamplingContextFrozen)
{
$spanContext = TransactionContext::fromEnvironment($sentryTrace, $baggage);

$this->assertEquals($expectedSpanId, $spanContext->getParentSpanId());
$this->assertEquals($expectedTraceId, $spanContext->getTraceId());
$this->assertSame($expectedParentSampled, $spanContext->getParentSampled());
$this->assertInstanceOf($expectedDynamicSamplingContextClass, $spanContext->getMetadata()->getDynamicSamplingContext());
$this->assertSame($expectedDynamicSamplingContextFrozen, $spanContext->getMetadata()->getDynamicSamplingContext()->isFrozen());
}

public function tracingDataProvider(): iterable
{
yield [
'0',
Expand Down