feat: Add experimental response propagator interface

composer.json

@@ -129,6 +129,7 @@
         },
         "spi": {
             "OpenTelemetry\\API\\Configuration\\Config\\ComponentProvider": [
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\ResponsePropagatorComposite",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3Multi",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorBaggage",
@@ -179,6 +180,8 @@
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Metrics\\AggregationResolverExplicitBucketHistogram",
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Metrics\\MetricExporterPrometheus",
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Metrics\\MetricReaderPull",
+                "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\ResponsePropagatorServerTiming",
+                "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\ResponsePropagatorTraceResponse",
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\TextMapPropagatorXray",
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\TextMapPropagatorOtTrace"
             ],

examples/instrumentation/otel-sdk.yaml

@@ -3,6 +3,9 @@ file_format: '0.4'
 propagator:
   composite: []
 
+response_propagator/development:
+  composite: []
+
 tracer_provider:
   processors:
   - simple:

examples/load_config.yaml

@@ -9,6 +9,9 @@ resource:
 propagators:
   composite: [ tracecontext, baggage ]
 
+response_propagator/development:
+  composite: [ servertiming, traceresponse ]
+
 exporters:
   otlp: &otlp-exporter
     protocol: http/protobuf

examples/load_config_env.yaml

@@ -10,6 +10,9 @@ resource:
 propagators:
   composite: [ tracecontext, baggage ]
 
+response_propagator/development:
+  composite: [ servertiming, traceresponse ]
+
 attribute_limits:
   attribute_value_length_limit: ${OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT}
   attribute_count_limit: ${OTEL_ATTRIBUTE_COUNT_LIMIT}

src/API/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);
     }
 
     /**

src/API/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(),
     ) {
     }
 }

src/API/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;
+    }
 }

src/API/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>
      */

src/API/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;
 }

src/API/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();
     }
 }

src/Config/SDK/ComponentProvider/OpenTelemetrySdk.php

@@ -11,8 +11,11 @@
 use OpenTelemetry\API\Configuration\Context;
 use OpenTelemetry\Config\SDK\Configuration\Validation;
 use OpenTelemetry\Config\SDK\Parser\AttributesParser;
+use OpenTelemetry\Context\Propagation\MultiResponsePropagator;
 use OpenTelemetry\Context\Propagation\MultiTextMapPropagator;
+use OpenTelemetry\Context\Propagation\NoopResponsePropagator;
 use OpenTelemetry\Context\Propagation\NoopTextMapPropagator;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
 use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeFactory;
@@ -87,6 +90,9 @@ final class OpenTelemetrySdk implements ComponentProvider
      *     propagator: array{
      *         composite: list<ComponentPlugin<TextMapPropagatorInterface>>,
      *     },
+     *     "response_propagator/development": array{
+     *         composite: list<ComponentPlugin<ResponsePropagatorInterface>>,
+     *     },
      *     tracer_provider: array{
      *         limits: array{
      *             attribute_value_length_limit: ?int<0, max>,
@@ -177,6 +183,13 @@ public function createPlugin(array $properties, Context $context): SdkBuilder
         $propagator = ($propagators === []) ? NoopTextMapPropagator::getInstance() : new MultiTextMapPropagator($propagators);
         $sdkBuilder->setPropagator($propagator);
 
+        $responsePropagators = [];
+        foreach ($properties['response_propagator/development']['composite'] as $plugin) {
+            $responsePropagators[] = $plugin->create($context);
+        }
+        $responsePropagator = ($responsePropagators === []) ? NoopResponsePropagator::getInstance() : new MultiResponsePropagator($responsePropagators);
+        $sdkBuilder->setResponsePropagator($responsePropagator);
+
         if ($properties['disabled']) {
             return $sdkBuilder;
         }
@@ -403,6 +416,7 @@ public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $buil
                 ->append($this->getTracerProviderConfig($registry, $builder))
                 ->append($this->getMeterProviderConfig($registry, $builder))
                 ->append($this->getLoggerProviderConfig($registry, $builder))
+                ->append($this->getExperimentalResponsePropagatorConfig($registry, $builder))
             ->end();
 
         return $node;
@@ -684,4 +698,42 @@ private function getPropagatorConfig(ComponentProviderRegistry $registry, NodeBu
 
         return $node;
     }
+
+    private function getExperimentalResponsePropagatorConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
+    {
+        $node = $builder->arrayNode('response_propagator/development');
+        $node
+            ->beforeNormalization()
+            ->ifArray()
+            ->then(static function (array $value): array {
+                $existing = [];
+                foreach ($value['composite'] ?? [] as $item) {
+                    $existing[] = key($item);
+                }
+                foreach (explode(',', $value['composite_list'] ?? '') as $name) {
+                    $name = trim($name);
+                    if ($name !== '' && !in_array($name, $existing)) {
+                        $value['composite'][][$name] = null;
+                        $existing[] = $name;
+                    }
+                }
+
+                unset($value['composite_list']);
+
+                return $value;
+            })
+            ->end();
+
+        $node
+            ->addDefaultsIfNotSet()
+            ->children()
+            ->append($registry->componentList('composite', ResponsePropagatorInterface::class))
+//                ->arrayNode('composite_list')
+//                    ->scalarPrototype()->end()
+//                ->end()
+            ->end()
+        ;
+
+        return $node;
+    }
 }

src/Config/SDK/ComponentProvider/Propagator/ResponsePropagatorComposite.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Config\SDK\ComponentProvider\Propagator;
+
+use OpenTelemetry\API\Configuration\Config\ComponentPlugin;
+use OpenTelemetry\API\Configuration\Config\ComponentProvider;
+use OpenTelemetry\API\Configuration\Config\ComponentProviderRegistry;
+use OpenTelemetry\API\Configuration\Context;
+use OpenTelemetry\Context\Propagation\MultiResponsePropagator;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
+
+/**
+ * @implements ComponentProvider<ResponsePropagatorInterface>
+ */
+final class ResponsePropagatorComposite implements ComponentProvider
+{
+    /**
+     * @param list<ComponentPlugin<ResponsePropagatorInterface>> $properties
+     */
+    #[\Override]
+    public function createPlugin(array $properties, Context $context): ResponsePropagatorInterface
+    {
+        $responsePropagators = [];
+        foreach ($properties as $plugin) {
+            $responsePropagators[] = $plugin->create($context);
+        }
+
+        return new MultiResponsePropagator($responsePropagators);
+    }
+
+    #[\Override]
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
+    {
+        return $registry->componentNames('composite', ResponsePropagatorInterface::class);
+    }
+}

src/Config/SDK/composer.json

@@ -40,6 +40,7 @@
         },
         "spi": {
             "OpenTelemetry\\API\\Configuration\\Config\\ComponentProvider": [
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\ResponsePropagatorComposite",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3Multi",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorBaggage",