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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Http;
use Wikimedia\Http\TelemetryHeadersInterface;
/**
* Service for handling telemetry data
* @unstable
* @since 1.41
*/
class Telemetry implements TelemetryHeadersInterface {
/**
* @var Telemetry|null
*/
private static ?Telemetry $instance = null;
/**
*
* @var string|null Request id
*/
private ?string $reqId = null;
/**
* Server and execution environment information.
*
* @see https://www.php.net/manual/en/reserved.variables.server.php
* @var array
*/
private array $server;
private ?bool $allowExternalReqID;
/**
* @param array $server Server and execution environment information, most likely the $_SERVER variable
*/
public function __construct( array $server, ?bool $allowExternalReqID = null ) {
$this->server = $server;
$this->allowExternalReqID = $allowExternalReqID;
}
public static function getInstance(): Telemetry {
if ( !isset( self::$instance ) ) {
global $wgAllowExternalReqID;
self::$instance = new self( $_SERVER, $wgAllowExternalReqID );
}
return self::$instance;
}
/**
* Get the current request ID.
*
* This is usually based on the `X-Request-Id` header, or the `UNIQUE_ID`
* environment variable, falling back to (process cached) randomly-generated string.
*
* @return string
*/
public function getRequestId(): string {
// This method is called from various error handlers and MUST be kept simple and stateless.
if ( !isset( $this->reqId ) ) {
if ( $this->allowExternalReqID ) {
$id = ( $this->server['HTTP_X_REQUEST_ID'] ?? $this->server['UNIQUE_ID'] ?? wfRandomString( 24 ) );
} else {
$id = ( $this->server['UNIQUE_ID'] ?? wfRandomString( 24 ) );
}
$this->reqId = $id;
}
return $this->reqId;
}
/**
* Override the unique request ID. This is for sub-requests, such as jobs,
* that wish to use the same id but are not part of the same execution context.
*
* @param string $newId
*/
public function overrideRequestId( string $newId ): void {
$this->reqId = $newId;
}
/**
* Regenerate the request id by setting it to null, next call to `getRequestId`
* will refetch the request id from header/UNIQUE_ID or regenerate it.
* @return void
*/
public function regenerateRequestId() {
$this->reqId = null;
}
/**
* Get the OpenTelemetry tracestate info
* Returns null when not present or AllowExternalReqID is set to false
*
* @return string|null
*/
public function getTracestate(): ?string {
return $this->allowExternalReqID ? $this->server['HTTP_TRACESTATE'] ?? null : null;
}
/**
* Get the OpenTelemetry traceparent info,
* Returns null when not present or AllowExternalReqID is set to false
*
* @return string|null
*/
public function getTraceparent(): ?string {
return $this->allowExternalReqID ? $this->server['HTTP_TRACEPARENT'] ?? null : null;
}
/**
* Return Telemetry data in form of request headers
* @return array
*/
public function getRequestHeaders(): array {
return array_filter( [
'tracestate' => $this->getTracestate(),
'traceparent' => $this->getTraceparent(),
'X-Request-Id' => $this->getRequestId()
] );
}
}
|
