CloudTracePropagator
in package
implements
TextMapPropagatorInterface
FinalYes
CloudTracePropagator is a propagator that supports the specification for the X-Cloud-Trace-Context header used for trace context propagation across service boundaries.
(https://cloud.google.com/trace/docs/setup#force-trace)
Table of Contents
Interfaces
Constants
Properties
- $instance : TextMapPropagatorInterface|null
- $oneWay : bool
- $oneWayInstance : TextMapPropagatorInterface|null
Methods
- extract() : ContextInterface
- Extracts specific values from the provided carrier into the provided {@see ContextInterface} via an {@see PropagationGetterInterface}.
- fields() : array<int, string>
- Returns list of fields that will be used by this propagator.
- getInstance() : TextMapPropagatorInterface
- getOneWayInstance() : TextMapPropagatorInterface
- inject() : void
- Injects specific values from the provided {@see ContextInterface} into the provided carrier via an {@see PropagationSetterInterface}.
- __construct() : mixed
Constants
FIELDS
private
mixed
FIELDS
= [self::XCLOUD]
XCLOUD
private
mixed
XCLOUD
= 'x-cloud-trace-context'
Properties
$instance
private
static TextMapPropagatorInterface|null
$instance
= null
$oneWay read-only
private
bool
$oneWay
$oneWayInstance
private
static TextMapPropagatorInterface|null
$oneWayInstance
= null
Methods
extract()
Extracts specific values from the provided carrier into the provided {@see ContextInterface} via an {@see PropagationGetterInterface}.
public
extract(mixed $carrier[, PropagationGetterInterface|null $getter = null ][, ContextInterface|null $context = null ]) : ContextInterface
Parameters
- $carrier : mixed
- $getter : PropagationGetterInterface|null = null
- $context : ContextInterface|null = null
Attributes
- #[Override]
Return values
ContextInterfacefields()
Returns list of fields that will be used by this propagator.
public
fields() : array<int, string>
Attributes
- #[Override]
Return values
array<int, string>getInstance()
public
static getInstance() : TextMapPropagatorInterface
Return values
TextMapPropagatorInterfacegetOneWayInstance()
public
static getOneWayInstance() : TextMapPropagatorInterface
Return values
TextMapPropagatorInterfaceinject()
Injects specific values from the provided {@see ContextInterface} into the provided carrier via an {@see PropagationSetterInterface}.
public
inject(mixed &$carrier[, PropagationSetterInterface|null $setter = null ][, ContextInterface|null $context = null ]) : void
Parameters
- $carrier : mixed
- $setter : PropagationSetterInterface|null = null
- $context : ContextInterface|null = null
Attributes
- #[Override]
__construct()
private
__construct(bool $oneWay) : mixed
Parameters
- $oneWay : bool