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
102 lines
2.5 KiB
PHP
102 lines
2.5 KiB
PHP
<?php
|
|
namespace Wikimedia\Telemetry;
|
|
|
|
use GuzzleHttp\Psr7\Utils;
|
|
use Psr\Http\Client\ClientExceptionInterface;
|
|
use Psr\Http\Client\ClientInterface;
|
|
use Psr\Http\Message\RequestFactoryInterface;
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
/**
|
|
* An {@link ExporterInterface} that exports collected data over HTTP, serialized in OTLP JSON format.
|
|
*
|
|
* @since 1.43
|
|
* @internal
|
|
*/
|
|
class OtlpHttpExporter implements ExporterInterface {
|
|
private ClientInterface $client;
|
|
private RequestFactoryInterface $requestFactory;
|
|
private LoggerInterface $logger;
|
|
|
|
/**
|
|
* URI of the OTLP receiver endpoint to send data to.
|
|
* @var string
|
|
*/
|
|
private string $endpoint;
|
|
|
|
/**
|
|
* Descriptive name used to identify this service in traces.
|
|
* @var string
|
|
*/
|
|
private string $serviceName;
|
|
|
|
/**
|
|
* The host name of this server to be reported in traces.
|
|
* @var string
|
|
*/
|
|
private string $hostName;
|
|
|
|
public function __construct(
|
|
ClientInterface $client,
|
|
RequestFactoryInterface $requestFactory,
|
|
LoggerInterface $logger,
|
|
string $uri,
|
|
string $serviceName,
|
|
string $hostName
|
|
) {
|
|
$this->client = $client;
|
|
$this->requestFactory = $requestFactory;
|
|
$this->logger = $logger;
|
|
$this->endpoint = $uri;
|
|
$this->serviceName = $serviceName;
|
|
$this->hostName = $hostName;
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function export( TracerState $tracerState ): void {
|
|
$spanContexts = $tracerState->getSpanContexts();
|
|
if ( count( $spanContexts ) === 0 ) {
|
|
return;
|
|
}
|
|
|
|
$resourceInfo = array_filter( [
|
|
'service.name' => $this->serviceName,
|
|
'host.name' => $this->hostName,
|
|
"server.socket.address" => $_SERVER['SERVER_ADDR'] ?? null,
|
|
] );
|
|
|
|
$data = [
|
|
'resourceSpans' => [
|
|
[
|
|
'resource' => [
|
|
'attributes' => OtlpSerializer::serializeKeyValuePairs( $resourceInfo )
|
|
],
|
|
'scopeSpans' => [
|
|
[
|
|
'scope' => [
|
|
'name' => 'org.wikimedia.telemetry',
|
|
],
|
|
'spans' => $spanContexts
|
|
]
|
|
]
|
|
]
|
|
]
|
|
];
|
|
|
|
$request = $this->requestFactory->createRequest( 'POST', $this->endpoint )
|
|
->withHeader( 'Content-Type', 'application/json' )
|
|
->withBody( Utils::streamFor( json_encode( $data ) ) );
|
|
|
|
try {
|
|
$response = $this->client->sendRequest( $request );
|
|
if ( $response->getStatusCode() !== 200 ) {
|
|
$this->logger->error( 'Failed to export trace data' );
|
|
}
|
|
} catch ( ClientExceptionInterface $e ) {
|
|
$this->logger->error( 'Failed to connect to exporter', [ 'exception' => $e ] );
|
|
}
|
|
|
|
// Clear out finished spans after exporting them.
|
|
$tracerState->clearSpanContexts();
|
|
}
|
|
}
|