aboutsummaryrefslogtreecommitdiffstats
path: root/includes/libs/telemetry/NoopTracer.php
blob: 075fcc83c5254b368ec5b9a078306899b1edbac6 (plain) (blame)
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
<?php
namespace Wikimedia\Telemetry;

/**
 * A no-op tracer that creates no-op spans and persists no data.
 * Useful for scenarios where tracing is disabled.
 * Can still propagate some (not-Span-specific) context, like X-Request-Id.
 *
 * @since 1.43
 * @internal
 */
class NoopTracer implements TracerInterface {

	private SpanContext $noopSpanContext;
	private TracerState $tracerState;
	private ?ContextPropagatorInterface $contextPropagator;

	public function __construct( ?ContextPropagatorInterface $contextPropagator = null ) {
		$this->noopSpanContext = new SpanContext( '', '', null, '', false );
		$this->tracerState = new TracerState();
		$this->contextPropagator = $contextPropagator;
	}

	/** @inheritDoc */
	public function createSpan( string $spanName, $parentSpan = null ): SpanInterface {
		return new NoopSpan( $this->tracerState, $this->noopSpanContext );
	}

	/** @inheritDoc */
	public function createRootSpan( string $spanName ): SpanInterface {
		return new NoopSpan( $this->tracerState, $this->noopSpanContext );
	}

	/** @inheritDoc */
	public function createSpanWithParent( string $spanName, SpanContext $parentSpanContext ): SpanInterface {
		return new NoopSpan( $this->tracerState, $this->noopSpanContext );
	}

	/** @inheritDoc */
	public function shutdown(): void {
		// no-op
	}

	/** @inheritDoc */
	public function createRootSpanFromCarrier( string $spanName, array $carrier ): SpanInterface {
		return new NoopSpan( $this->tracerState, $this->noopSpanContext );
	}

	/** @inheritDoc */
	public function getRequestHeaders(): array {
		$rv = [];
		if ( $this->contextPropagator ) {
			$rv = $this->contextPropagator->inject( $this->noopSpanContext, $rv );
		}
		return $rv;
	}
}