wiki.techinc.nl/includes/libs/telemetry/OtlpSerializer.php
Máté Szabó 16ec1a3703 Introduce minimal OTEL tracing library
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
2024-10-09 15:55:31 +02:00

43 lines
967 B
PHP

<?php
namespace Wikimedia\Telemetry;
/**
* Utility class for serializing data in OTLP JSON format.
*
* @since 1.43
* @internal
*/
class OtlpSerializer {
/**
* Map of PHP types to their corresponding type name used in the OTLP JSON format.
*/
private const TYPE_MAP = [
'string' => 'stringValue',
'integer' => 'intValue',
'boolean' => 'boolValue',
'double' => 'doubleValue',
'array' => 'arrayValue'
];
/**
* Serialize an associative array into the format expected by the OTLP JSON format.
* @param array $keyValuePairs The associative array to serialize
* @return array
*/
public static function serializeKeyValuePairs( array $keyValuePairs ): array {
$serialized = [];
foreach ( $keyValuePairs as $key => $value ) {
$type = gettype( $value );
if ( isset( self::TYPE_MAP[$type] ) ) {
$serialized[] = [
'key' => $key,
'value' => [ self::TYPE_MAP[$type] => $value ]
];
}
}
return $serialized;
}
}