feat: Add experimental response propagator interface (#1712)

* Added experimental response propagator

* Added response propagator interface to Globals

* changed to experimental_response_propagator

* Update src/API/Globals.php

Co-authored-by: Brett McBride <[email protected]>

* Update src/Context/Propagation/ResponsePropagatorInterface.php

Co-authored-by: Brett McBride <[email protected]>

* Update src/Config/SDK/ComponentProvider/OpenTelemetrySdk.php

Co-authored-by: Tobias Bachert <[email protected]>

* Changed experimental_response_propagator to response_propagator/development

* Cleaned up the comment

* Bumped context and api version

* Bumped open-telemetry/sdk in open-telemetry/sdk-configuration

---------

Co-authored-by: Brett McBride <[email protected]>
Co-authored-by: Tobias Bachert <[email protected]>

Author: 3 people

Globals.php

@@ -14,6 +14,7 @@
 use OpenTelemetry\API\Metrics\MeterProviderInterface;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
 use OpenTelemetry\Context\Context;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use function sprintf;
 use Throwable;
@@ -35,6 +36,7 @@ public function __construct(
         private readonly LoggerProviderInterface $loggerProvider,
         private readonly EventLoggerProviderInterface $eventLoggerProvider,
         private readonly TextMapPropagatorInterface $propagator,
+        private readonly ResponsePropagatorInterface $responsePropagator,
     ) {
     }
 
@@ -53,6 +55,14 @@ public static function propagator(): TextMapPropagatorInterface
         return Context::getCurrent()->get(ContextKeys::propagator()) ?? self::globals()->propagator;
     }
 
+    /**
+     * @experimental
+     */
+    public static function responsePropagator(): ResponsePropagatorInterface
+    {
+        return Context::getCurrent()->get(ContextKeys::responsePropagator()) ?? self::globals()->responsePropagator;
+    }
+
     public static function loggerProvider(): LoggerProviderInterface
     {
         return Context::getCurrent()->get(ContextKeys::loggerProvider()) ?? self::globals()->loggerProvider;
@@ -107,12 +117,13 @@ private static function globals(): self
         $tracerProvider = $context->get(ContextKeys::tracerProvider());
         $meterProvider = $context->get(ContextKeys::meterProvider());
         $propagator = $context->get(ContextKeys::propagator());
+        $responsePropagator = $context->get(ContextKeys::responsePropagator());
         $loggerProvider = $context->get(ContextKeys::loggerProvider());
         $eventLoggerProvider = $context->get(ContextKeys::eventLoggerProvider());
 
-        assert(isset($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator));
+        assert(isset($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator, $responsePropagator));
 
-        return self::$globals = new self($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator);
+        return self::$globals = new self($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator, $responsePropagator);
     }
 
     /**

Instrumentation/AutoInstrumentation/Context.php

@@ -10,7 +10,9 @@
 use OpenTelemetry\API\Metrics\Noop\NoopMeterProvider;
 use OpenTelemetry\API\Trace\NoopTracerProvider;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
+use OpenTelemetry\Context\Propagation\NoopResponsePropagator;
 use OpenTelemetry\Context\Propagation\NoopTextMapPropagator;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 
 /**
@@ -23,6 +25,7 @@ public function __construct(
         public readonly MeterProviderInterface $meterProvider = new NoopMeterProvider(),
         public readonly LoggerProviderInterface $loggerProvider = new NoopLoggerProvider(),
         public readonly TextMapPropagatorInterface $propagator = new NoopTextMapPropagator(),
+        public readonly ResponsePropagatorInterface $responsePropagator = new NoopResponsePropagator(),
     ) {
     }
 }

Instrumentation/Configurator.php

@@ -15,7 +15,9 @@
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\Context\ImplicitContextKeyedInterface;
+use OpenTelemetry\Context\Propagation\NoopResponsePropagator;
 use OpenTelemetry\Context\Propagation\NoopTextMapPropagator;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use OpenTelemetry\Context\ScopeInterface;
 
@@ -31,6 +33,7 @@ final class Configurator implements ImplicitContextKeyedInterface
     private ?TextMapPropagatorInterface $propagator = null;
     private ?LoggerProviderInterface $loggerProvider = null;
     private ?EventLoggerProviderInterface $eventLoggerProvider = null;
+    private ?ResponsePropagatorInterface $responsePropagator = null;
 
     private function __construct()
     {
@@ -56,6 +59,7 @@ public static function createNoop(): Configurator
             ->withPropagator(new NoopTextMapPropagator())
             ->withLoggerProvider(NoopLoggerProvider::getInstance())
             ->withEventLoggerProvider(new NoopEventLoggerProvider())
+            ->withResponsePropagator(new NoopResponsePropagator())
         ;
     }
 
@@ -88,6 +92,9 @@ public function storeInContext(?ContextInterface $context = null): ContextInterf
         if ($this->eventLoggerProvider !== null) {
             $context = $context->with(ContextKeys::eventLoggerProvider(), $this->eventLoggerProvider);
         }
+        if ($this->responsePropagator !== null) {
+            $context = $context->with(ContextKeys::responsePropagator(), $this->responsePropagator);
+        }
 
         return $context;
     }
@@ -134,4 +141,12 @@ public function withEventLoggerProvider(?EventLoggerProviderInterface $eventLogg
 
         return $self;
     }
+
+    public function withResponsePropagator(?ResponsePropagatorInterface $responsePropagator): Configurator
+    {
+        $self = clone $this;
+        $self->responsePropagator = $responsePropagator;
+
+        return $self;
+    }
 }

Instrumentation/ContextKeys.php

@@ -10,6 +10,7 @@
 use OpenTelemetry\API\Trace\TracerProviderInterface;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Context\ContextKeyInterface;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 
 /**
@@ -47,6 +48,16 @@ public static function propagator(): ContextKeyInterface
         return $instance ??= Context::createKey(TextMapPropagatorInterface::class);
     }
 
+    /**
+     * @return ContextKeyInterface<ResponsePropagatorInterface>
+     */
+    public static function responsePropagator(): ContextKeyInterface
+    {
+        static $instance;
+
+        return $instance ??= Context::createKey(ResponsePropagatorInterface::class);
+    }
+
     /**
      * @return ContextKeyInterface<LoggerProviderInterface>
      */

Instrumentation/InstrumentationInterface.php

@@ -8,6 +8,7 @@
 use OpenTelemetry\API\Metrics\MeterProviderInterface;
 use OpenTelemetry\API\Trace\TracerInterface;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use Psr\Log\LoggerInterface;
 
@@ -40,4 +41,8 @@ public function getMeter(): MeterInterface;
     public function setLogger(LoggerInterface $logger): void;
 
     public function getLogger(): LoggerInterface;
+
+    public function setResponsePropagator(ResponsePropagatorInterface $responsePropagator): void;
+
+    public function getResponsePropagator(): ResponsePropagatorInterface;
 }

Instrumentation/InstrumentationTrait.php

@@ -11,7 +11,9 @@
 use OpenTelemetry\API\Trace\NoopTracerProvider;
 use OpenTelemetry\API\Trace\TracerInterface;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
+use OpenTelemetry\Context\Propagation\NoopResponsePropagator;
 use OpenTelemetry\Context\Propagation\NoopTextMapPropagator;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
@@ -68,6 +70,7 @@ trait InstrumentationTrait
     private TracerInterface $tracer;
     private MeterInterface $meter;
     private LoggerInterface $logger;
+    private ResponsePropagatorInterface $responsePropagator;
 
     public function __construct()
     {
@@ -171,6 +174,16 @@ public function getLogger(): LoggerInterface
         return $this->logger;
     }
 
+    public function setResponsePropagator(ResponsePropagatorInterface $responsePropagator): void
+    {
+        $this->responsePropagator = $responsePropagator;
+    }
+
+    public function getResponsePropagator(): ResponsePropagatorInterface
+    {
+        return $this->responsePropagator;
+    }
+
     private function validateImplementation(): void
     {
         if (!$this instanceof InstrumentationInterface) {
@@ -190,5 +203,6 @@ private function initDefaults(): void
         /** @phan-suppress-next-line PhanAccessMethodInternal */
         $this->meter = new NoopMeter();
         $this->logger = new NullLogger();
+        $this->responsePropagator = new NoopResponsePropagator();
     }
 }

composer.json

@@ -18,7 +18,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "open-telemetry/context": "^1.0",
+        "open-telemetry/context": "^1.4",
         "psr/log": "^1.1|^2.0|^3.0",
         "symfony/polyfill-php82": "^1.26"
     },