SamplingResult
Read onlyYes
FinalYes
Result of a sampling decision.
Contains the sampling decision along with additional attributes that should be added to the span and an optional updated trace state.
Example usage:
$result = new SamplingResult(
SamplingDecision::RECORD_AND_SAMPLE,
['sampling.reason' => 'head-based'],
);
if ($result->decision->isSampled()) {
// Create and export the span
}
Tags
Properties
- $attributes : TAttributeValueMap
- $decision : SamplingDecision
- $traceState : TraceState|null
Methods
- __construct() : mixed
- drop() : self
- Create a result indicating the span should be dropped.
- recordAndSample() : self
- Create a result indicating the span should be recorded and exported.
- recordOnly() : self
- Create a result indicating the span should be recorded but not exported.
Properties
$attributes
public
TAttributeValueMap
$attributes
$decision
public
SamplingDecision
$decision
$traceState
public
TraceState|null
$traceState
= null
Methods
__construct()
public
__construct(SamplingDecision $decision[, TAttributeValueMap|Attributes $attributes = [] ][, null|TraceState $traceState = null ]) : mixed
Parameters
- $decision : SamplingDecision
-
The sampling decision
- $attributes : TAttributeValueMap|Attributes = []
-
Additional span attributes from the sampler
- $traceState : null|TraceState = null
-
Updated trace state, or null to keep existing
drop()
Create a result indicating the span should be dropped.
public
static drop() : self
Return values
selfrecordAndSample()
Create a result indicating the span should be recorded and exported.
public
static recordAndSample([TAttributeValueMap|Attributes $attributes = [] ][, TraceState|null $traceState = null ]) : self
Parameters
- $attributes : TAttributeValueMap|Attributes = []
- $traceState : TraceState|null = null
Return values
selfrecordOnly()
Create a result indicating the span should be recorded but not exported.
public
static recordOnly([TAttributeValueMap|Attributes $attributes = [] ][, TraceState|null $traceState = null ]) : self
Parameters
- $attributes : TAttributeValueMap|Attributes = []
- $traceState : TraceState|null = null