tests/phpunit/includes/libs/telemetry/TelemetryIntegrationTest.php

   1 <?php
   2 namespace Wikimedia\Tests\Telemetry;
   3
   4 use GuzzleHttp\Client;
   5 use GuzzleHttp\Handler\MockHandler;
   6 use GuzzleHttp\Psr7\Response;
   7 use MediaWiki\MainConfigNames;
   8 use MediaWikiIntegrationTestCase;
   9 use Wikimedia\Telemetry\Clock;
  10 use Wikimedia\Telemetry\NoopTracer;
  11 use Wikimedia\Telemetry\SpanInterface;
  12 use Wikimedia\Telemetry\Tracer;
  13 use Wikimedia\Telemetry\TracerState;
  14
  15 /**
  16  * @covers \Wikimedia\Telemetry\Tracer
  17  * @covers \Wikimedia\Telemetry\OtlpHttpExporter
  18  */
  19 class TelemetryIntegrationTest extends MediaWikiIntegrationTestCase {
  20         private const EXAMPLE_TRACING_CONFIG = [
  21                 'serviceName' => 'test-service',
  22                 'samplingProbability' => 100,
  23                 'endpoint' => 'http://198.51.100.42:4318/v1/traces'
  24         ];
  25
  26         private const EXAMPLE_TRACING_CONFIG_NO_SAMPLING = [
  27                 'serviceName' => 'test-service',
  28                 'samplingProbability' => 0,
  29                 'endpoint' => 'http://198.51.100.42:4318/v1/traces'
  30         ];
  31
  32         private MockHandler $handler;
  33
  34         protected function setUp(): void {
  35                 parent::setUp();
  36
  37                 $this->handler = new MockHandler();
  38                 $this->setService( '_TracerHTTPClient', new Client( [
  39                         'handler' => $this->handler,
  40                         'http_errors' => false
  41                 ] ) );
  42         }
  43
  44         protected function tearDown(): void {
  45                 parent::tearDown();
  46                 Clock::setMockTime( null );
  47                 TracerState::destroyInstance();
  48         }
  49
  50         public function testShouldDoNothingWhenTracingDisabled(): void {
  51                 $this->overrideConfigValue( MainConfigNames::OpenTelemetryConfig, null );
  52
  53                 $tracer = $this->getServiceContainer()->getTracer();
  54                 $span = $tracer->createSpan( 'test' )
  55                         ->start();
  56
  57                 $span->end();
  58
  59                 $tracer->shutdown();
  60
  61                 $this->assertInstanceOf( NoopTracer::class, $tracer );
  62                 $this->assertNull( $this->handler->getLastRequest() );
  63         }
  64
  65         public function testShouldDoNothingWhenNotSampled(): void {
  66                 $this->overrideConfigValue(
  67                         MainConfigNames::OpenTelemetryConfig,
  68                         self::EXAMPLE_TRACING_CONFIG_NO_SAMPLING
  69                 );
  70
  71                 $tracer = $this->getServiceContainer()->getTracer();
  72                 $span = $tracer->createRootSpan( 'test' )
  73                         ->start();
  74                 $span->activate();
  75
  76                 $child = $tracer->createSpan( 'child' )
  77                         ->start();
  78
  79                 $child->end();
  80
  81                 $span->end();
  82
  83                 $tracer->shutdown();
  84
  85                 $this->assertInstanceOf( Tracer::class, $tracer );
  86                 $this->assertNull( $this->handler->getLastRequest() );
  87         }
  88
  89         public function testShouldNotExportDataWhenNoSpansWereCreated(): void {
  90                 $this->overrideConfigValue( MainConfigNames::OpenTelemetryConfig, self::EXAMPLE_TRACING_CONFIG );
  91
  92                 $tracer = $this->getServiceContainer()->getTracer();
  93
  94                 $tracer->shutdown();
  95
  96                 $this->assertInstanceOf( Tracer::class, $tracer );
  97                 $this->assertNull( $this->handler->getLastRequest() );
  98         }
  99
 100         public function testShouldNotExportDataWhenTracerWasNotExplicitlyShutdown(): void {
 101                 $this->overrideConfigValue( MainConfigNames::OpenTelemetryConfig, self::EXAMPLE_TRACING_CONFIG );
 102
 103                 $tracer = $this->getServiceContainer()->getTracer();
 104                 $span = $tracer->createRootSpan( 'test' )
 105                         ->start();
 106
 107                 $span->end();
 108
 109                 $this->assertInstanceOf( Tracer::class, $tracer );
 110                 $this->assertNull( $this->handler->getLastRequest() );
 111         }
 112
 113         public function testShouldExportDataOnShutdownWhenTracingEnabled(): void {
 114                 $this->overrideConfigValue( MainConfigNames::OpenTelemetryConfig, self::EXAMPLE_TRACING_CONFIG );
 115                 $this->handler->append( new Response( 200 ) );
 116
 117                 $mockTime = 5481675965496;
 118                 Clock::setMockTime( $mockTime );
 119
 120                 $tracer = $this->getServiceContainer()->getTracer();
 121                 $span = $tracer->createRootSpan( 'test' )
 122                         ->setSpanKind( SpanInterface::SPAN_KIND_SERVER )
 123                         ->start();
 124
 125                 $span->activate();
 126
 127                 $mockTime += 100;
 128                 Clock::setMockTime( $mockTime );
 129
 130                 $childSpan = $tracer->createSpan( 'child' )
 131                         ->setAttributes( [ 'some-key' => 'test', 'ignored' => new \stdClass() ] )
 132                         ->start();
 133
 134                 $mockTime += 250;
 135                 Clock::setMockTime( $mockTime );
 136
 137                 $childSpan->end();
 138
 139                 $mockTime += 74;
 140                 Clock::setMockTime( $mockTime );
 141
 142                 $span->setSpanStatus( SpanInterface::SPAN_STATUS_ERROR );
 143                 $span->end();
 144
 145                 $this->assertNull(
 146                         $this->handler->getLastRequest(),
 147                         'Exporting trace data should be deferred until the tracer is explicitly shut down'
 148                 );
 149
 150                 $tracer->shutdown();
 151
 152                 $request = $this->handler->getLastRequest();
 153
 154                 $this->assertInstanceOf( Tracer::class, $tracer );
 155                 $this->assertSame( 'http://198.51.100.42:4318/v1/traces', (string)$request->getUri() );
 156                 $this->assertSame( 'application/json', $request->getHeaderLine( 'Content-Type' ) );
 157
 158                 $expected = file_get_contents( __DIR__ . '/expected-trace-data.json' );
 159
 160                 $expected = strtr( $expected, [
 161                         '<TRACE-ID>' => $span->getContext()->getTraceId(),
 162                         '<SPAN-1-ID>' => $span->getContext()->getSpanId(),
 163                         '<SPAN-2-ID>' => $childSpan->getContext()->getSpanId(),
 164                         '<HOST-NAME>' => wfHostname()
 165                 ] );
 166
 167                 $this->assertJsonStringEqualsJsonString(
 168                         $expected,
 169                         (string)$request->getBody()
 170                 );
 171         }
 172 }