tidy, adding initial otlp json support

open-telemetry · bobstrecansky · Nov 2, 2022 · Oct 6, 2022 · Oct 6, 2022 · Oct 6, 2022
commit b3108f5aefc6549d673efdd6879bbf1d29157bf5
@@ -11,7 +11,7 @@ RUN chmod +x /usr/local/bin/install-php-extensions; \
         zip \
         pcntl \
         grpc \
-	protobuf \
+        protobuf \
         sockets \
         intl \
         @composer \

@@ -7,7 +7,6 @@
 use OpenTelemetry\API\Common\Signal\Signals;
 use OpenTelemetry\Contrib\Grpc\GrpcTransportFactory;
 use OpenTelemetry\Contrib\Otlp\MetricExporter;
-use OpenTelemetry\Contrib\Otlp\Protocols;
 use OpenTelemetry\Example\ExampleMetricsGenerator;
 use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Metrics\MetricReader\ExportingReader;
@@ -18,8 +17,7 @@
 
 $reader = new ExportingReader(
     new MetricExporter(
-        (new GrpcTransportFactory())->withSignal(Signals::METRICS)->create('http://collector:4317'),
-        Protocols::GRPC,
+        (new GrpcTransportFactory())->withSignal(Signals::METRICS)->create('http://collector:4317')
     ),
     $clock
 );

@@ -6,7 +6,6 @@
 
 use OpenTelemetry\API\Common\Signal\Signals;
 use OpenTelemetry\Contrib\Otlp\MetricExporter;
-use OpenTelemetry\Contrib\Otlp\Protocols;
 use OpenTelemetry\Example\ExampleMetricsGenerator;
 use OpenTelemetry\SDK\Common\Export\Http\PsrTransportFactory;
 use OpenTelemetry\SDK\Common\Time\ClockFactory;
@@ -15,8 +14,7 @@
 $clock = ClockFactory::getDefault();
 $reader = new ExportingReader(
     new MetricExporter(
-        PsrTransportFactory::discover()->withSignal(Signals::METRICS)->create('http://collector:4318/v1/metrics', 'application/json'),
-        Protocols::HTTP_JSON //or Protocols::HTTP_PROTOBUF
+        PsrTransportFactory::discover()->withSignal(Signals::METRICS)->create('http://collector:4318/v1/metrics', 'application/json')
     ),
     $clock
 );

@@ -5,7 +5,6 @@
 require __DIR__ . '/../../../../vendor/autoload.php';
 
 use OpenTelemetry\Contrib\Otlp\MetricExporter;
-use OpenTelemetry\Contrib\Otlp\Protocols;
 use OpenTelemetry\Example\ExampleMetricsGenerator;
 use OpenTelemetry\SDK\Common\Export\Stream\StreamTransport;
 use OpenTelemetry\SDK\Common\Time\ClockFactory;
@@ -14,8 +13,7 @@
 $clock = ClockFactory::getDefault();
 $reader = new ExportingReader(
     new MetricExporter(
-        new StreamTransport(STDOUT, 'application/x-ndjson'),
-        Protocols::HTTP_ND_JSON
+        new StreamTransport(STDOUT, 'application/x-ndjson')
     ),
     $clock
 );

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+require __DIR__ . '/../../../../vendor/autoload.php';
+
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
+use OpenTelemetry\Contrib\Otlp\Protocols;
+use OpenTelemetry\Contrib\Otlp\SpanExporter;
+use OpenTelemetry\Contrib\OtlpHttp\OtlpHttpTransportFactory;
+use OpenTelemetry\SDK\Common\Log\LoggerHolder;
+use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
+use OpenTelemetry\SDK\Trace\TracerProvider;
+
+LoggerHolder::set(new Logger('otlp-example', [new StreamHandler('php://stderr')]));
+
+$transport = (new OtlpHttpTransportFactory())->withProtocol(Protocols::HTTP_JSON)->create('http://collector:4318');
+$exporter = new SpanExporter($transport);
+
+echo 'Starting OTLP+json example';
+
+$tracerProvider =  new TracerProvider(
+    new SimpleSpanProcessor(
+        $exporter
+    )
+);
+$tracer = $tracerProvider->getTracer('io.opentelemetry.contrib.php');
+
+$root = $span = $tracer->spanBuilder('root')->startSpan();
+$root->end();
+echo PHP_EOL . 'OTLP+json example complete!  ';
+
+echo PHP_EOL;
+$tracerProvider->shutdown();
@@ -30,7 +30,7 @@ private function __construct(string $contentType)
     }
 
     /**
-     * @param TransportInterface<SUPPORTED_CONTENT_TYPES> $transport
+     * @psalm-param TransportInterface<SUPPORTED_CONTENT_TYPES> $transport
      */
     public static function forTransport(TransportInterface $transport): ProtobufSerializer
     {
@@ -50,6 +50,7 @@ public function serialize(Message $message): string
             case self::PROTOBUF:
                 return $message->serializeToString();
             case self::JSON:
+                //@todo https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#json-protobuf-encoding
                 return $message->serializeToJsonString();
             case self::NDJSON:
                 return $message->serializeToJsonString() . "\n";

@@ -12,12 +12,12 @@ class Protocols
     public const GRPC = KnownValues::VALUE_GRPC;
     public const HTTP_PROTOBUF = KnownValues::VALUE_HTTP_PROTOBUF;
     public const HTTP_JSON = KnownValues::VALUE_HTTP_JSON;
-    public const HTTP_ND_JSON = KnownValues::VALUE_HTTP_NDJSON;
+    public const HTTP_NDJSON = KnownValues::VALUE_HTTP_NDJSON;
     private const PROTOCOLS = [
         self::GRPC => 'application/x-protobuf',
         self::HTTP_PROTOBUF => 'application/x-protobuf',
         self::HTTP_JSON => 'application/json',
-        self::HTTP_ND_JSON => 'application/x-ndjson',
+        self::HTTP_NDJSON => 'application/x-ndjson',
     ];
 
     public static function validate(string $protocol): void

diff --git a/src/SDK/Common/Export/TransportInterface.php b/src/SDK/Common/Export/TransportInterface.php
@@ -12,8 +12,6 @@
  */
 interface TransportInterface
 {
-    public const CONTENT_TYPE_PROTOBUF = 'application/x-protobuf';
-
     public function contentType(): string;
 
     public function send(string $payload, ?CancellationInterface $cancellation = null): FutureInterface;

@@ -28,6 +28,7 @@ class ExporterFactory
         'zipkin+http' => '\OpenTelemetry\Contrib\Zipkin\Exporter',
         'otlp+grpc' => '\OpenTelemetry\Contrib\Otlp\SpanExporter',
         'otlp+http' => '\OpenTelemetry\Contrib\Otlp\SpanExporter',
+        'otlp+json' => '\OpenTelemetry\Contrib\Otlp\SpanExporter',
         'newrelic+http' => '\OpenTelemetry\Contrib\Newrelic\Exporter',
         'zipkintonewrelic+http' => '\OpenTelemetry\Contrib\ZipkinToNewrelic\Exporter',
         // this entry exists only for testing purposes
@@ -36,10 +37,12 @@ class ExporterFactory
     private const KNOWN_TRANSPORT_FACTORIES = [
         'otlp+grpc' => '\OpenTelemetry\Contrib\Grpc\GrpcTransportFactory',
         'otlp+http' => '\OpenTelemetry\Contrib\OtlpHttp\OtlpHttpTransportFactory',
+        'otlp+json' => '\OpenTelemetry\Contrib\OtlpHttp\OtlpHttpTransportFactory',
     ];
     private const KNOWN_TRANSPORT_PROTOCOLS = [
         'otlp+grpc' => KnownValues::VALUE_GRPC,
         'otlp+http' => KnownValues::VALUE_HTTP_PROTOBUF,
+        'otlp+json' => KnownValues::VALUE_HTTP_JSON,
     ];
 
     private const DEFAULT_SERVICE_NAME = 'unknown_service';
@@ -117,7 +120,7 @@ public function fromEnvironment(): ?SpanExporterInterface
                     case Values::VALUE_HTTP_PROTOBUF:
                         return self::buildExporterWithTransport('otlp+http');
                     case Values::VALUE_HTTP_JSON:
-                        throw new InvalidArgumentException('otlp+http/json not implemented');
+                        return self::buildExporterWithTransport('otlp+json');
                     default:
                         throw new InvalidArgumentException('Unknown protocol: ' . $protocol);
                 }

@@ -121,6 +121,11 @@ public function envProvider(): array
                 ['OTEL_EXPORTER_OTLP_PROTOCOL' => 'grpc'],
                 Contrib\Otlp\SpanExporter::class,
             ],
+            'otlp+json from protocol' => [
+                'otlp',
+                ['OTEL_EXPORTER_OTLP_PROTOCOL' => 'http/json'],
+                Contrib\Otlp\SpanExporter::class,
+            ],
             'console' => [
                 'console', [], ConsoleSpanExporter::class,
             ],
@@ -149,10 +154,6 @@ public function invalidEnvProvider(): array
             'zipkin' => ['zipkin'],
             'newrelic' => ['newrelic'],
             'zipkintonewrelic' => ['zipkintonewrelic'],
-            'otlp+http/json' => [
-                'otlp',
-                ['OTEL_EXPORTER_OTLP_PROTOCOL' => 'http/json'],
-            ],
             'otlp+invalid protocol' => [
                 'otlp',
                 ['OTEL_EXPORTER_OTLP_PROTOCOL' => 'foo'],