16ec1a3703
In T340552, the official PHP OpenTelemetry client was effectively rejected for inclusion in MediaWiki due to its size. Implement a minimal tracing library instead that eschews conformance with the OTEL client specification in favor of simplicity, while remaining capable of emitting trace data in OTLP format and thus retaining compatibility with any ingestion endpoint capable of handling OTLP. In its current state, the library supports a basic feature set that should be sufficient for basic tracing integration: * Span creation, inclusive span activation and automatic parent span assignment, * Span attributes and span kinds, * Basic resource (process/request)-level metadata generation, * Data export over OTLP. Additional functionality, such as trace propagation, can then be incrementally added to the library. Bug: T340552 Change-Id: Ibc3910058cd7ed064cad293a3cdc091344e66b86
92 lines
2.2 KiB
PHP
92 lines
2.2 KiB
PHP
<?php
|
|
namespace Wikimedia\Telemetry;
|
|
|
|
use Wikimedia\Assert\Assert;
|
|
|
|
/**
|
|
* Represents an OpenTelemetry span, i.e. a single operation within a trace.
|
|
*
|
|
* @since 1.43
|
|
* @see https://opentelemetry.io/docs/specs/otel/trace/api/#span
|
|
*/
|
|
class Span implements SpanInterface {
|
|
|
|
private Clock $clock;
|
|
|
|
private TracerState $tracerState;
|
|
|
|
private SpanContext $context;
|
|
|
|
public function __construct(
|
|
Clock $clock,
|
|
TracerState $tracerState,
|
|
SpanContext $context
|
|
) {
|
|
$this->clock = $clock;
|
|
$this->tracerState = $tracerState;
|
|
$this->context = $context;
|
|
}
|
|
|
|
public function __destruct() {
|
|
$this->end();
|
|
$activeSpanContext = $this->tracerState->getActiveSpanContext();
|
|
if ( $this->context->equals( $activeSpanContext ) ) {
|
|
$this->deactivate();
|
|
}
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function getContext(): SpanContext {
|
|
return $this->context;
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function setAttributes( array $attributes ): SpanInterface {
|
|
$this->context->setAttributes( $attributes );
|
|
return $this;
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function setSpanKind( int $spanKind ): SpanInterface {
|
|
$this->context->setSpanKind( $spanKind );
|
|
return $this;
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function start( ?int $epochNanos = null ): SpanInterface {
|
|
Assert::precondition(
|
|
!$this->context->wasStarted(),
|
|
'Cannot start a span more than once'
|
|
);
|
|
|
|
$this->context->setStartEpochNanos( $epochNanos ?? $this->clock->getCurrentNanoTime() );
|
|
|
|
return $this;
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function end( ?int $epochNanos = null ): void {
|
|
Assert::precondition(
|
|
$this->context->wasStarted(),
|
|
'Cannot end a span that has not been started'
|
|
);
|
|
|
|
// Make duplicate end() calls a no-op, since it may occur legitimately,
|
|
// e.g. when a span wrapped in an RAII ScopedSpan wrapper is ended explicitly.
|
|
if ( !$this->context->wasEnded() ) {
|
|
$this->context->setEndEpochNanos( $epochNanos ?? $this->clock->getCurrentNanoTime() );
|
|
$this->tracerState->addSpanContext( $this->context );
|
|
}
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function activate(): void {
|
|
$this->tracerState->activateSpan( $this->getContext() );
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function deactivate(): void {
|
|
$this->tracerState->deactivateSpan( $this->getContext() );
|
|
}
|
|
|
|
}
|