summaryrefslogtreecommitdiff
path: root/classes/tracer.php
blob: 7163adb90e53e9a50ad4038f781d65dda79b2d06 (plain)
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<?php

use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
use OpenTelemetry\API\Trace\SpanContextInterface;
use OpenTelemetry\API\Trace\SpanInterface;
use OpenTelemetry\API\Trace\SpanKind;
use OpenTelemetry\API\Trace\TraceFlags;
use OpenTelemetry\API\Trace\TraceStateInterface;
use OpenTelemetry\Context\ContextInterface;
use OpenTelemetry\Context\ContextKey;
use OpenTelemetry\Context\ContextKeyInterface;
use OpenTelemetry\Context\ImplicitContextKeyedInterface;
use OpenTelemetry\Context\ScopeInterface;
use OpenTelemetry\Contrib\Otlp\OtlpHttpTransportFactory;
use OpenTelemetry\Contrib\Otlp\SpanExporter;
use OpenTelemetry\SDK\Common\Attribute\Attributes;
use OpenTelemetry\SDK\Resource\ResourceInfo;
use OpenTelemetry\SDK\Resource\ResourceInfoFactory;
use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
use OpenTelemetry\SDK\Trace\Sampler\ParentBased;
use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
use OpenTelemetry\SDK\Trace\TracerProvider;
use OpenTelemetry\SemConv\ResourceAttributes;

class DummyContextInterface implements ContextInterface {

	/** @var DummyContextInterface */
	private static $instance;

	public function __construct() {
		self::$instance = $this;
	}

	/** @phpstan-ignore-next-line */
	public static function createKey(string $key): ContextKeyInterface { return new ContextKey(); }

	public static function getCurrent(): ContextInterface { return self::$instance; }

	public function activate(): ScopeInterface { return new DummyScopeInterface(); }

	public function with(ContextKeyInterface $key, $value): ContextInterface { return $this; }

	public function withContextValue(ImplicitContextKeyedInterface $value): ContextInterface { return $this; }

	public function get(ContextKeyInterface $key) { return new ContextKey(); }

}

class DummySpanContextInterface implements SpanContextInterface {

	/** @var DummySpanContextInterface $instance */
	private static $instance;

	public function __construct() {
		self::$instance = $this;
	}

	public static function createFromRemoteParent(string $traceId, string $spanId, int $traceFlags = TraceFlags::DEFAULT, ?TraceStateInterface $traceState = null): SpanContextInterface { return self::$instance; }

	public static function getInvalid(): SpanContextInterface { return self::$instance; }

	public static function create(string $traceId, string $spanId, int $traceFlags = TraceFlags::DEFAULT, ?TraceStateInterface $traceState = null): SpanContextInterface { return self::$instance; }

	public function getTraceId(): string { return ""; }

	public function getTraceIdBinary(): string { return ""; }

	public function getSpanId(): string { return ""; }

	public function getSpanIdBinary(): string { return ""; }

	public function getTraceFlags(): int { return 0; }

	public function getTraceState(): ?TraceStateInterface { return null; }

	public function isValid(): bool { return false; }

	public function isRemote(): bool { return false; }

	public function isSampled(): bool { return false; }
}

class DummyScopeInterface implements ScopeInterface {
	public function detach(): int { return 0; }
}

class DummySpanInterface implements SpanInterface {

	/** @var DummySpanInterface $instance */
	private static $instance;

	public function __construct() {
		self::$instance = $this;
	}

	public static function fromContext(ContextInterface $context): SpanInterface { return self::$instance; }

	public static function getCurrent(): SpanInterface { return self::$instance; }

	public static function getInvalid(): SpanInterface { return self::$instance; }

	public static function wrap(SpanContextInterface $spanContext): SpanInterface { return self::$instance; }

	public function getContext(): SpanContextInterface { return new DummySpanContextInterface(); }

	public function isRecording(): bool { return false; }

	/** @phpstan-ignore-next-line */
	public function setAttribute(string $key, $value): SpanInterface { return self::$instance; }

	/** @phpstan-ignore-next-line */
	public function setAttributes(iterable $attributes): SpanInterface { return self::$instance; }

	/** @phpstan-ignore-next-line */
	public function addEvent(string $name, iterable $attributes = [], ?int $timestamp = null): SpanInterface { return $this; }

	/** @phpstan-ignore-next-line */
	public function recordException(Throwable $exception, iterable $attributes = []): SpanInterface { return $this; }

	public function updateName(string $name): SpanInterface { return $this; }

	public function setStatus(string $code, ?string $description = null): SpanInterface { return $this; }

	public function end(?int $endEpochNanos = null): void { }

	public function activate(): ScopeInterface { return new DummyScopeInterface(); }

	public function storeInContext(ContextInterface $context): ContextInterface { return new DummyContextInterface(); }

}

class Tracer {
	/** @var Tracer $instance */
	private static $instance = null;

	/** @var OpenTelemetry\SDK\Trace\TracerProviderInterface $tracerProvider */
	private $tracerProvider = null;

	/** @var OpenTelemetry\API\Trace\TracerInterface $tracer */
	private $tracer = null;

	public function __construct() {
		$OPENTELEMETRY_ENDPOINT = Config::get(Config::OPENTELEMETRY_ENDPOINT);

		if ($OPENTELEMETRY_ENDPOINT) {
			$transport = (new OtlpHttpTransportFactory())->create($OPENTELEMETRY_ENDPOINT, 'application/x-protobuf');
			$exporter = new SpanExporter($transport);

			$resource = ResourceInfoFactory::emptyResource()->merge(
				ResourceInfo::create(Attributes::create(
					[ResourceAttributes::SERVICE_NAME => Config::get(Config::OPENTELEMETRY_SERVICE)]
				), ResourceAttributes::SCHEMA_URL),
			);

			$this->tracerProvider = TracerProvider::builder()
				->addSpanProcessor(new SimpleSpanProcessor($exporter))
				->setResource($resource)
				->setSampler(new ParentBased(new AlwaysOnSampler()))
				->build();

			$this->tracer = $this->tracerProvider->getTracer('io.opentelemetry.contrib.php');

			$context = TraceContextPropagator::getInstance()->extract(getallheaders());

			$span = $this->tracer->spanBuilder($_SESSION['name'] ?? 'not logged in')
				->setParent($context)
				->setSpanKind(SpanKind::KIND_SERVER)
				->setAttribute('php.request', json_encode($_REQUEST))
				->setAttribute('php.server', json_encode($_SERVER))
				->setAttribute('php.session', json_encode($_SESSION ?? []))
				->startSpan();

			$scope = $span->activate();

			register_shutdown_function(function() use ($span, $scope) {
				$span->end();
				$scope->detach();
				$this->tracerProvider->shutdown();
			});
		}
	}

	/**
	 * @param string $name
	 * @return OpenTelemetry\API\Trace\SpanInterface
	 */
	private function _start(string $name) {
		if ($this->tracer != null) {
			$span = $this->tracer
				->spanBuilder($name)
				->setSpanKind(SpanKind::KIND_SERVER)
				->startSpan();

			$span->activate();
		} else {
			$span = new DummySpanInterface();
		}

		return $span;
	}

	/**
	 * @param string $name
	 * @return OpenTelemetry\API\Trace\SpanInterface
	 */
	public static function start(string $name) {
		return self::get_instance()->_start($name);
	}

	public static function get_instance() : Tracer {
		if (self::$instance == null)
			self::$instance = new self();

		return self::$instance;
	}
}