1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
<?php
declare(strict_types=1);
namespace OpenTelemetry\SDK\Trace\Sampler;
use OpenTelemetry\Context\ContextInterface;
use OpenTelemetry\SDK\Common\Attribute\AttributesInterface;
use OpenTelemetry\SDK\Trace\SamplerInterface;
use OpenTelemetry\SDK\Trace\SamplingResult;
use OpenTelemetry\SDK\Trace\Span;
/**
* Phan seems to struggle with the variadic arguments in the latest version
* @phan-file-suppress PhanParamTooFewUnpack
*/
/**
* This implementation of the SamplerInterface that respects parent context's sampling decision
* and delegates for the root span.
* Example:
* ```
* use OpenTelemetry\API\Trace\ParentBased;
* use OpenTelemetry\API\Trace\AlwaysOnSampler
*
* $rootSampler = new AlwaysOnSampler();
* $sampler = new ParentBased($rootSampler);
* ```
*/
class ParentBased implements SamplerInterface
{
private SamplerInterface $root;
private SamplerInterface $remoteParentSampler;
private SamplerInterface $remoteParentNotSampler;
private SamplerInterface $localParentSampler;
private SamplerInterface $localParentNotSampler;
/**
* ParentBased sampler delegates the sampling decision based on the parent context.
*
* @param SamplerInterface $root Sampler called for the span with no parent (root span).
* @param SamplerInterface|null $remoteParentSampler Sampler called for the span with the remote sampled parent. When null, `AlwaysOnSampler` is used.
* @param SamplerInterface|null $remoteParentNotSampler Sampler called for the span with the remote not sampled parent. When null, `AlwaysOffSampler` is used.
* @param SamplerInterface|null $localParentSampler Sampler called for the span with local the sampled parent. When null, `AlwaysOnSampler` is used.
* @param SamplerInterface|null $localParentNotSampler Sampler called for the span with the local not sampled parent. When null, `AlwaysOffSampler` is used.
*/
public function __construct(
SamplerInterface $root,
?SamplerInterface $remoteParentSampler = null,
?SamplerInterface $remoteParentNotSampler = null,
?SamplerInterface $localParentSampler = null,
?SamplerInterface $localParentNotSampler = null
) {
$this->root = $root;
$this->remoteParentSampler = $remoteParentSampler ?? new AlwaysOnSampler();
$this->remoteParentNotSampler = $remoteParentNotSampler ?? new AlwaysOffSampler();
$this->localParentSampler = $localParentSampler ?? new AlwaysOnSampler();
$this->localParentNotSampler = $localParentNotSampler ?? new AlwaysOffSampler();
}
/**
* Invokes the respective delegate sampler when parent is set or uses root sampler for the root span.
* {@inheritdoc}
*/
public function shouldSample(
ContextInterface $parentContext,
string $traceId,
string $spanName,
int $spanKind,
AttributesInterface $attributes,
array $links
): SamplingResult {
$parentSpan = Span::fromContext($parentContext);
$parentSpanContext = $parentSpan->getContext();
// Invalid parent SpanContext indicates root span is being created
if (!$parentSpanContext->isValid()) {
return $this->root->shouldSample(...func_get_args());
}
if ($parentSpanContext->isRemote()) {
return $parentSpanContext->isSampled()
? $this->remoteParentSampler->shouldSample(...func_get_args())
: $this->remoteParentNotSampler->shouldSample(...func_get_args());
}
return $parentSpanContext->isSampled()
? $this->localParentSampler->shouldSample(...func_get_args())
: $this->localParentNotSampler->shouldSample(...func_get_args());
}
public function getDescription(): string
{
return 'ParentBased+' . $this->root->getDescription();
}
}
|
