declarative config 0.3+ support (#1452)

This brings declarative config support up to 0.3 plus some of the unreleased 0.4 features: * porting code from Nevay/otel-sdk-configuration * support 0.4 metric reader config * allow empty keys since open-telemetry/opentelemetry-specification#4269 empty keys are allows, and NULL is no longer equivalent to unset * update config example to remove empty objects * remove moved component providers from composer.json * add ComponentProviderRegistry::componentMap for instrumentation configuration
open-telemetry · Jan 9, 2025 · 83cddd9 · 83cddd9
1 parent 4b575e6
commit 83cddd9
Show file tree

Hide file tree

Showing 105 changed files with 1,697 additions and 757 deletions.
diff --git a/composer.json b/composer.json
@@ -155,7 +155,13 @@
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Instrumentation\\General\\HttpConfigProvider",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Instrumentation\\General\\PeerConfigProvider",
 
-                "OpenTelemetry\\Example\\ExampleConfigProvider"
+                "OpenTelemetry\\Example\\ExampleConfigProvider",
+
+                "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\\TextMapPropagatorXray",
+                "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\TextMapPropagatorOtTrace"
             ],
             "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\HookManagerInterface": [
               "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\ExtensionHookManager"

diff --git a/examples/instrumentation/otel-sdk.yaml b/examples/instrumentation/otel-sdk.yaml
@@ -1,12 +1,18 @@
 file_format: '0.3'
 
+propagator:
+  composite: []
+
 tracer_provider:
   processors:
   - simple:
       exporter:
-        console: {}
+        console:
+  sampler:
+    always_on:
 
 instrumentation:
+  general:
   php:
     example_instrumentation:
       span_name: ${EXAMPLE_INSTRUMENTATION_SPAN_NAME:-example span}
diff --git a/examples/load_config.yaml b/examples/load_config.yaml
@@ -18,19 +18,19 @@ tracer_provider:
   sampler:
     parent_based:
       root:
-        always_on: {}
+        always_on:
   processors:
     - simple:
         exporter:
-          console: {}
+          console:
     - batch:
         exporter:
           otlp: *otlp-exporter
 meter_provider:
   readers:
     - periodic:
         exporter:
-          console: {}
+          console:
     - periodic:
         exporter:
           otlp:
@@ -40,7 +40,7 @@ logger_provider:
   processors:
     - simple:
         exporter:
-          console: {}
+          console:
     - batch:
         exporter:
           otlp: *otlp-exporter
diff --git a/examples/src/ExampleConfigProvider.php b/examples/src/ExampleConfigProvider.php
@@ -10,6 +10,7 @@
 use OpenTelemetry\Config\SDK\Configuration\Context;
 use OpenTelemetry\Config\SDK\Configuration\Validation;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<InstrumentationConfiguration>
@@ -34,16 +35,16 @@ public function createPlugin(array $properties, Context $context): Instrumentati
     /**
      * @psalm-suppress UndefinedInterfaceMethod,PossiblyNullReference
      */
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $root = new ArrayNodeDefinition('example_instrumentation');
-        $root
+        $node = $builder->arrayNode('example_instrumentation');
+        $node
             ->children()
                 ->scalarNode('span_name')->isRequired()->validate()->always(Validation::ensureString())->end()->end()
             ->end()
             ->canBeDisabled()
         ;
 
-        return $root;
+        return $node;
     }
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -38,6 +38,7 @@ parameters:
             message: "#Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface::.*#"
             paths:
                 - src/Config/SDK
+                - tests/Integration/Config
         -
             message: "#Cannot call method .* on null#"
             paths:

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -37,25 +37,48 @@
                 <directory name="./examples"/>
             </errorLevel>
         </ArgumentTypeCoercion>
+        <InvalidArgument>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/Configuration/Internal"/>
+            </errorLevel>
+        </InvalidArgument>
         <UndefinedInterfaceMethod>
             <errorLevel type="suppress">
                 <directory name="src/Config/SDK/ComponentProvider"/>
+                <directory name="tests/Integration/Config/ComponentProvider"/>
             </errorLevel>
         </UndefinedInterfaceMethod>
+        <PossiblyInvalidArgument>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/Configuration"/>
+            </errorLevel>
+        </PossiblyInvalidArgument>
         <PossiblyNullReference>
             <errorLevel type="suppress">
                 <directory name="src/Config/SDK/ComponentProvider"/>
+                <directory name="tests/Integration/Config/ComponentProvider"/>
             </errorLevel>
         </PossiblyNullReference>
         <MoreSpecificImplementedParamType>
             <errorLevel type="suppress">
                 <directory name="src/Config/SDK/ComponentProvider"/>
+                <directory name="tests/Integration/Config/ComponentProvider"/>
             </errorLevel>
         </MoreSpecificImplementedParamType>
         <InvalidDocblock>
             <errorLevel type="suppress">
                 <directory name="src/Config/SDK/ComponentProvider"/>
             </errorLevel>
         </InvalidDocblock>
+        <NonInvariantDocblockPropertyType>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/Configuration/Internal"/>
+            </errorLevel>
+        </NonInvariantDocblockPropertyType>
+        <NonInvariantPropertyType>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/Configuration/Internal"/>
+            </errorLevel>
+        </NonInvariantPropertyType>
     </issueHandlers>
 </psalm>
diff --git a/src/Config/SDK/ComponentProvider/Instrumentation/General/HttpConfigProvider.php b/src/Config/SDK/ComponentProvider/Instrumentation/General/HttpConfigProvider.php
@@ -10,6 +10,7 @@
 use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
 use OpenTelemetry\Config\SDK\Configuration\Context;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<GeneralInstrumentationConfiguration>
@@ -21,22 +22,22 @@ public function createPlugin(array $properties, Context $context): GeneralInstru
         return new HttpConfig($properties);
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $node = new ArrayNodeDefinition('http');
+        $node = $builder->arrayNode('http');
         $node
             ->children()
-                ->append($this->capturedHeaders('client'))
-                ->append($this->capturedHeaders('server'))
+                ->append($this->capturedHeaders('client', $builder))
+                ->append($this->capturedHeaders('server', $builder))
             ->end()
         ;
 
         return $node;
     }
 
-    private function capturedHeaders(string $name): ArrayNodeDefinition
+    private function capturedHeaders(string $name, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $node = new ArrayNodeDefinition($name);
+        $node = $builder->arrayNode($name);
         $node
             ->children()
                 ->arrayNode('request_captured_headers')

diff --git a/src/Config/SDK/ComponentProvider/Instrumentation/General/PeerConfigProvider.php b/src/Config/SDK/ComponentProvider/Instrumentation/General/PeerConfigProvider.php
@@ -10,6 +10,7 @@
 use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
 use OpenTelemetry\Config\SDK\Configuration\Context;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<GeneralInstrumentationConfiguration>
@@ -21,9 +22,9 @@ public function createPlugin(array $properties, Context $context): GeneralInstru
         return new PeerConfig($properties);
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $node = new ArrayNodeDefinition('peer');
+        $node = $builder->arrayNode('peer');
         $node
             ->children()
                 ->arrayNode('service_mapping')

diff --git a/src/Config/SDK/ComponentProvider/InstrumentationConfigurationRegistry.php b/src/Config/SDK/ComponentProvider/InstrumentationConfigurationRegistry.php
@@ -12,6 +12,7 @@
 use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
 use OpenTelemetry\Config\SDK\Configuration\Context;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @internal
@@ -24,7 +25,7 @@ class InstrumentationConfigurationRegistry implements ComponentProvider
      * @param array{
      *     instrumentation: array{
      *         php: list<ComponentPlugin<InstrumentationConfiguration>>,
-     *         general: list<ComponentPlugin<InstrumentationConfiguration>>
+     *         general: list<ComponentPlugin<GeneralInstrumentationConfiguration>>
      *     }
      * } $properties
      */
@@ -43,18 +44,16 @@ public function createPlugin(array $properties, Context $context): Configuration
         return $configurationRegistry;
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $root = new ArrayNodeDefinition('open_telemetry');
+        $root = $builder->arrayNode('open_telemetry');
         $root
             ->ignoreExtraKeys()
             ->children()
                 ->arrayNode('instrumentation')
                     ->ignoreExtraKeys()
-                    ->children()
-                        ->append($registry->componentList('php', InstrumentationConfiguration::class))
-                        ->append($registry->componentList('general', GeneralInstrumentationConfiguration::class))
-                    ->end()
+                    ->append($registry->componentMap('php', InstrumentationConfiguration::class))
+                    ->append($registry->componentMap('general', GeneralInstrumentationConfiguration::class))
                 ->end()
             ->end()
         ;

diff --git a/src/Config/SDK/ComponentProvider/Logs/LogRecordExporterConsole.php b/src/Config/SDK/ComponentProvider/Logs/LogRecordExporterConsole.php
@@ -11,6 +11,7 @@
 use OpenTelemetry\SDK\Logs\LogRecordExporterInterface;
 use OpenTelemetry\SDK\Registry;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<LogRecordExporterInterface>
@@ -28,8 +29,8 @@ public function createPlugin(array $properties, Context $context): LogRecordExpo
         ));
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        return new ArrayNodeDefinition('console');
+        return $builder->arrayNode('console');
     }
 }
diff --git a/src/Config/SDK/ComponentProvider/Logs/LogRecordExporterOtlp.php b/src/Config/SDK/ComponentProvider/Logs/LogRecordExporterOtlp.php
@@ -17,6 +17,7 @@
 use OpenTelemetry\SDK\Logs\LogRecordExporterInterface;
 use OpenTelemetry\SDK\Registry;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<LogRecordExporterInterface>
@@ -35,6 +36,7 @@ final class LogRecordExporterOtlp implements ComponentProvider
      *     headers_list: ?string,
      *     compression: 'gzip'|null,
      *     timeout: int<0, max>,
+     *     insecure: ?bool,
      * } $properties
      */
     public function createPlugin(array $properties, Context $context): LogRecordExporterInterface
@@ -55,9 +57,9 @@ public function createPlugin(array $properties, Context $context): LogRecordExpo
         ));
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $node = new ArrayNodeDefinition('otlp');
+        $node = $builder->arrayNode('otlp');
         $node
             ->children()
                 ->enumNode('protocol')->isRequired()->values(['http/protobuf', 'http/json', 'grpc'])->end()
@@ -76,6 +78,7 @@ public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinit
                 ->scalarNode('headers_list')->defaultNull()->validate()->always(Validation::ensureString())->end()->end()
                 ->enumNode('compression')->values(['gzip'])->defaultNull()->end()
                 ->integerNode('timeout')->min(0)->defaultValue(10)->end()
+                ->booleanNode('insecure')->defaultNull()->end()
             ->end()
         ;
 

diff --git a/src/Config/SDK/ComponentProvider/Logs/LogRecordProcessorBatch.php b/src/Config/SDK/ComponentProvider/Logs/LogRecordProcessorBatch.php
@@ -13,6 +13,7 @@
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
 use OpenTelemetry\SDK\Logs\Processor\BatchLogRecordProcessor;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<LogRecordProcessorInterface>
@@ -41,9 +42,9 @@ public function createPlugin(array $properties, Context $context): LogRecordProc
         );
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $node = new ArrayNodeDefinition('batch');
+        $node = $builder->arrayNode('batch');
         $node
             ->children()
                 ->integerNode('schedule_delay')->min(0)->defaultValue(5000)->end()

diff --git a/src/Config/SDK/ComponentProvider/Logs/LogRecordProcessorSimple.php b/src/Config/SDK/ComponentProvider/Logs/LogRecordProcessorSimple.php
@@ -12,6 +12,7 @@
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
 use OpenTelemetry\SDK\Logs\Processor\SimpleLogRecordProcessor;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<LogRecordProcessorInterface>
@@ -30,9 +31,9 @@ public function createPlugin(array $properties, Context $context): LogRecordProc
         );
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        $node = new ArrayNodeDefinition('simple');
+        $node = $builder->arrayNode('simple');
         $node
             ->children()
                 ->append($registry->component('exporter', LogRecordExporterInterface::class)->isRequired())

diff --git a/src/Config/SDK/ComponentProvider/Metrics/AggregationResolverDefault.php b/src/Config/SDK/ComponentProvider/Metrics/AggregationResolverDefault.php
@@ -10,6 +10,7 @@
 use OpenTelemetry\SDK\Metrics\DefaultAggregationProviderInterface;
 use OpenTelemetry\SDK\Metrics\DefaultAggregationProviderTrait;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<DefaultAggregationProviderInterface>
@@ -27,8 +28,8 @@ public function createPlugin(array $properties, Context $context): DefaultAggreg
         };
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        return new ArrayNodeDefinition('default');
+        return $builder->arrayNode('default');
     }
 }
diff --git a/src/Config/SDK/ComponentProvider/Metrics/MetricExporterConsole.php b/src/Config/SDK/ComponentProvider/Metrics/MetricExporterConsole.php
@@ -10,6 +10,7 @@
 use OpenTelemetry\SDK\Metrics\MetricExporter\ConsoleMetricExporter;
 use OpenTelemetry\SDK\Metrics\MetricExporterInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 
 /**
  * @implements ComponentProvider<MetricExporterInterface>
@@ -24,8 +25,8 @@ public function createPlugin(array $properties, Context $context): MetricExporte
         return new ConsoleMetricExporter();
     }
 
-    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
     {
-        return new ArrayNodeDefinition('console');
+        return $builder->arrayNode('console');
     }
 }