Represents an OpenTelemetry span, i.e. More...
Inherits Wikimedia\Telemetry\SpanInterface.
Public Member Functions | ||||
| __construct (Clock $clock, TracerState $tracerState, SpanContext $context) | ||||
| __destruct () | ||||
| activate () | ||||
Make this span the active span.This will cause any spans started without specifying an explicit parent to automatically become children of this span as long as it remains active.
| ||||
| deactivate () | ||||
Deactivate this span.
| ||||
| end (?int $epochNanos=null) | ||||
End this span, optionally specifying an override for its end time.
| ||||
| getContext () | ||||
Get the context holding data for this span.
| ||||
| setAttributes (array $attributes) | ||||
Set attributes (arbitrary metadata) for this span.Any existing attributes with the same keys will be overwritten. Attributes with a null value will be ignored during export.When deciding on the set of attributes to register as well as their naming, consider following Semantic Conventions where applicable.
| ||||
| setSpanKind (int $spanKind) | ||||
Set the kind of this span, which describes how it relates to its parent and children within the overarching trace.
| ||||
| start (?int $epochNanos=null) | ||||
Start this span, optionally specifying an override for its start time.
| ||||
Additional Inherited Members | |
 Public Attributes inherited from Wikimedia\Telemetry\SpanInterface | |
| const | SPAN_KIND_CLIENT = 3 |
| Indicates that the span describes a request to some remote service. | |
| const | SPAN_KIND_CONSUMER = 5 |
Indicates that the span describes a child of an asynchronous SpanInterface::SPAN_KIND_PRODUCER request. | |
| const | SPAN_KIND_INTERNAL = 1 |
| Default value. | |
| const | SPAN_KIND_PRODUCER = 4 |
| Indicates that the span describes the initiators of an asynchronous request. | |
| const | SPAN_KIND_SERVER = 2 |
| Indicates that the span covers server-side handling of a synchronous RPC or other remote request. | |
Detailed Description
Represents an OpenTelemetry span, i.e.
a single operation within a trace.
- Since
- 1.43
Constructor & Destructor Documentation
◆ __construct()
| Wikimedia\Telemetry\Span::__construct | ( | Clock | $clock, |
| TracerState | $tracerState, | ||
| SpanContext | $context ) |
◆ __destruct()
| Wikimedia\Telemetry\Span::__destruct | ( | ) |
Definition at line 30 of file Span.php.
References Wikimedia\Telemetry\Span\deactivate(), and Wikimedia\Telemetry\Span\end().
Member Function Documentation
◆ activate()
| Wikimedia\Telemetry\Span::activate | ( | ) |
Make this span the active span.This will cause any spans started without specifying an explicit parent to automatically become children of this span as long as it remains active.
- Returns
- void
Implements Wikimedia\Telemetry\SpanInterface.
◆ deactivate()
| Wikimedia\Telemetry\Span::deactivate | ( | ) |
Deactivate this span.
- Returns
- void
Implements Wikimedia\Telemetry\SpanInterface.
Definition at line 88 of file Span.php.
Referenced by Wikimedia\Telemetry\Span\__destruct().
◆ end()
| Wikimedia\Telemetry\Span::end | ( | ?int | $epochNanos = null | ) |
End this span, optionally specifying an override for its end time.
- Parameters
-
int | null $epochNanos The end time to use, or nullto use the current time.
- Returns
- void
Implements Wikimedia\Telemetry\SpanInterface.
Definition at line 68 of file Span.php.
Referenced by Wikimedia\Telemetry\Span\__destruct().
◆ getContext()
| Wikimedia\Telemetry\Span::getContext | ( | ) |
Get the context holding data for this span.
- Returns
- SpanContext
Implements Wikimedia\Telemetry\SpanInterface.
◆ setAttributes()
| Wikimedia\Telemetry\Span::setAttributes | ( | array | $attributes | ) |
Set attributes (arbitrary metadata) for this span.Any existing attributes with the same keys will be overwritten. Attributes with a null value will be ignored during export.When deciding on the set of attributes to register as well as their naming, consider following Semantic Conventions where applicable.
- Parameters
-
array $attributes key-value mapping of attribute names to values
- Returns
- SpanInterface fluent interface
Implements Wikimedia\Telemetry\SpanInterface.
◆ setSpanKind()
| Wikimedia\Telemetry\Span::setSpanKind | ( | int | $spanKind | ) |
Set the kind of this span, which describes how it relates to its parent and children within the overarching trace.
- Parameters
-
int $spanKind One of the SpanInterface::SPAN_KIND_** constants
- Returns
- SpanInterface fluent interface
Implements Wikimedia\Telemetry\SpanInterface.
◆ start()
| Wikimedia\Telemetry\Span::start | ( | ?int | $epochNanos = null | ) |
Start this span, optionally specifying an override for its start time.
- Parameters
-
int | null $epochNanos The start time to use, or nullto use the current time.
- Returns
- SpanInterface
Implements Wikimedia\Telemetry\SpanInterface.
The documentation for this class was generated from the following file:
- includes/libs/telemetry/Span.php
