update declarative config to 1.0-rc.2 (#1733)

brettmc · web-flow · commit f413878aeff1 · 2025-12-17T08:10:08.000-05:00
* fixing psalm and rector complaints * suppress some new psalm complaints * apply x2 rector suggested fixes * update declarative config to 1.0-rc.2 - adds service detector - configurator name and config are not required see https://github.com/open-telemetry/opentelemetry-configuration/releases/tag/v1.0.0-rc.1 and https://github.com/open-telemetry/opentelemetry-configuration/releases/tag/v1.0.0-rc.2 * move non-standard (php-specific, for now) config to own file * default disabled not required * update prometheus test exporter config * add test for empty tracer config * disabled optional
diff --git a/composer.json b/composer.json
@@ -170,6 +170,7 @@
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Composer",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Host",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Process",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Service",
 
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Instrumentation\\General\\HttpConfigProvider",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Instrumentation\\General\\PeerConfigProvider",
diff --git a/src/Config/SDK/ComponentProvider/Detector/Service.php b/src/Config/SDK/ComponentProvider/Detector/Service.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Config\SDK\ComponentProvider\Detector;
+
+use OpenTelemetry\API\Configuration\Config\ComponentProvider;
+use OpenTelemetry\API\Configuration\Config\ComponentProviderRegistry;
+use OpenTelemetry\API\Configuration\Context;
+use OpenTelemetry\SDK\Resource\Detectors\Service as ServiceDetector;
+use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
+
+/**
+ * @implements ComponentProvider<ResourceDetectorInterface>
+ */
+final class Service implements ComponentProvider
+{
+    /**
+     * @param array{} $properties
+     */
+    #[\Override]
+    public function createPlugin(array $properties, Context $context): ResourceDetectorInterface
+    {
+        return new ServiceDetector();
+    }
+
+    #[\Override]
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
+    {
+        return $builder->arrayNode('service');
+    }
+}
diff --git a/src/Config/SDK/ComponentProvider/OpenTelemetrySdk.php b/src/Config/SDK/ComponentProvider/OpenTelemetrySdk.php
@@ -62,7 +62,7 @@ final class OpenTelemetrySdk implements ComponentProvider
 {
     /**
      * @param array{
-     *     file_format: '0.4',
+     *     file_format: '1.0-rc.2',
      *     disabled: bool,
      *     resource: array{
      *         attributes: array{
@@ -111,7 +111,7 @@ final class OpenTelemetrySdk implements ComponentProvider
      *              tracers: list<array{
      *                  name: string,
      *                  config: array{
-     *                      disabled: bool,
+     *                      disabled: ?bool,
      *                  }
      *              }>
      *           }
@@ -239,7 +239,7 @@ public function createPlugin(array $properties, Context $context): SdkBuilder
         $configurator = Configurator::tracer()->with(static fn (TracerConfig $config) => $config->setDisabled($disabled), null);
 
         foreach ($properties['tracer_provider']['tracer_configurator/development']['tracers'] ?? [] as $tracer) {
-            $disabled = $tracer['config']['disabled'];
+            $disabled = $tracer['config']['disabled'] ?? false;
             $configurator = $configurator->with(
                 static fn (TracerConfig $config) => $config->setDisabled($disabled),
                 name: $tracer['name'],
@@ -409,7 +409,7 @@ public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $buil
                     ->isRequired()
                     ->example('0.1')
                     ->validate()->always(Validation::ensureString())->end()
-                    ->validate()->ifNotInArray(['0.4'])->thenInvalid('unsupported version')->end()
+                    ->validate()->ifNotInArray(['1.0-rc.2'])->thenInvalid('unsupported version')->end()
                 ->end()
                 ->booleanNode('disabled')->defaultFalse()->end()
                 ->append($this->getResourceConfig($registry, $builder))
@@ -504,17 +504,17 @@ private function getTracerProviderConfig(ComponentProviderRegistry $registry, No
                         ->arrayNode('default_config')
                             ->addDefaultsIfNotSet()
                             ->children()
-                                ->booleanNode('disabled')->isRequired()->end()
+                                ->booleanNode('disabled')->end()
                             ->end()
                         ->end()
                         ->arrayNode('tracers')
                             ->arrayPrototype()
                                 ->children()
-                                    ->scalarNode('name')->isRequired()->cannotBeEmpty()->end()
+                                    ->scalarNode('name')->end()
                                     ->arrayNode('config')
                                         ->addDefaultsIfNotSet()
                                         ->children()
-                                            ->booleanNode('disabled')->isRequired()->end()
+                                            ->booleanNode('disabled')->end()
                                         ->end()
                                     ->end()
                                 ->end()
diff --git a/src/Config/SDK/composer.json b/src/Config/SDK/composer.json
@@ -80,6 +80,7 @@
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Composer",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Host",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Process",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Detector\\Service",
 
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Instrumentation\\General\\HttpConfigProvider",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Instrumentation\\General\\PeerConfigProvider"
diff --git a/tests/Integration/Config/ComponentProvider/Metrics/MetricExporterPrometheus.php b/tests/Integration/Config/ComponentProvider/Metrics/MetricExporterPrometheus.php
@@ -56,8 +56,6 @@ public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $buil
             ->children()
                 ->scalarNode('host')->isRequired()->validate()->always(Validation::ensureString())->end()->end()
                 ->scalarNode('port')->isRequired()->validate()->always(Validation::ensureNumber())->end()->end()
-                ->booleanNode('without_units')->defaultFalse()->end()
-                ->booleanNode('without_type_suffix')->defaultFalse()->end()
                 ->booleanNode('without_scope_info')->defaultFalse()->end()
                 ->booleanNode('without_scope_trace')->defaultFalse()->end()
                 ->arrayNode('with_resource_constant_labels')
@@ -70,6 +68,15 @@ public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $buil
                         ->end()
                     ->end()
                 ->end()
+                ->enumNode('translation_strategy')
+                    ->defaultValue('UnderscoreEscapingWithSuffixes')
+                    ->values([
+                        'UnderscoreEscapingWithSuffixes',
+                        'UnderscoreEscapingWithoutSuffixes',
+                        'NoUTF8EscapingWithSuffixes',
+                        'NoTranslation',
+                    ])
+                ->end()
             ->end()
         ;
 
diff --git a/tests/Integration/Config/ConfigurationTest.php b/tests/Integration/Config/ConfigurationTest.php
@@ -59,6 +59,7 @@ public static function openTelemetryConfigurationDataProvider(): iterable
     {
         yield 'kitchen-sink' => [__DIR__ . '/configurations/kitchen-sink.yaml'];
         yield 'anchors' => [__DIR__ . '/configurations/anchors.yaml'];
+        yield 'php-specific' => [__DIR__ . '/configurations/php-specific.yaml'];
     }
 
     public function test_configurators(): void
@@ -221,7 +222,7 @@ public function test_resource_attributes_take_precedence_over_default_attributes
         );
 
         $sdk = $factory->process([Yaml::parse(/** @lang yaml */<<<'YAML'
-            file_format: "0.4"
+            file_format: "1.0-rc.2"
             resource:
               attributes:
               - { name: service.name, value: test-service }
@@ -240,7 +241,7 @@ public function test_resource_detectors_take_precedence_over_default_attributes(
         );
 
         $sdk = $factory->process([Yaml::parse(/** @lang yaml */<<<'YAML'
-            file_format: "0.4"
+            file_format: "1.0-rc.2"
             resource:
               detection/development:
                 detectors:
@@ -262,7 +263,7 @@ public function test_resource_attributes_take_precedence_over_resource_detectors
         );
 
         $sdk = $factory->process([Yaml::parse(/** @lang yaml */<<<'YAML'
-            file_format: "0.4"
+            file_format: "1.0-rc.2"
             resource:
               attributes:
               - { name: service.name, value: test-service }
@@ -302,7 +303,7 @@ public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $buil
         );
 
         $sdk = $factory->process([Yaml::parse(/** @lang yaml */<<<'YAML'
-            file_format: "0.4"
+            file_format: "1.0-rc.2"
             resource:
               attributes:
               - { name: service.name, value: test-service }
@@ -331,4 +332,11 @@ private function getResource(Sdk $sdk): ResourceInfo
 
         return $resource;
     }
+
+    public function test_empty_tracer_configurator_config(): void
+    {
+        $file = __DIR__ . '/configurations/empty-tracer-config.yaml';
+        $this->expectNotToPerformAssertions();
+        Configuration::parseFile($file)->create();
+    }
 }
diff --git a/tests/Integration/Config/configurations/anchors.yaml b/tests/Integration/Config/configurations/anchors.yaml
@@ -1,6 +1,6 @@
 # anchors.yaml demonstrates anchor substitution to reuse OTLP exporter configuration across signals.
 
-file_format: "0.4"
+file_format: "1.0-rc.2"
 exporters:
     otlp: &otlp-exporter
         encoding: protobuf
diff --git a/tests/Integration/Config/configurations/configurators.yaml b/tests/Integration/Config/configurations/configurators.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 propagators:
   composite: [ tracecontext, baggage ]
diff --git a/tests/Integration/Config/configurations/empty-tracer-config.yaml b/tests/Integration/Config/configurations/empty-tracer-config.yaml
@@ -0,0 +1,7 @@
+file_format: "1.0-rc.2"
+
+tracer_provider:
+  tracer_configurator/development:
+    tracers:
+      - name: test
+        config:
diff --git a/tests/Integration/Config/configurations/experimental-response-propagators-duplicate.yaml b/tests/Integration/Config/configurations/experimental-response-propagators-duplicate.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 response_propagator/development:
   composite_list: "servertiming,servertiming"
diff --git a/tests/Integration/Config/configurations/kitchen-sink.yaml b/tests/Integration/Config/configurations/kitchen-sink.yaml
@@ -8,7 +8,7 @@
 # The file format version.
 # The yaml format is documented at
 # https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
-file_format: "0.4"
+file_format: "1.0-rc.2"
 # Configure if the SDK is disabled or not.
 # If omitted or null, false is used.
 disabled: false
@@ -200,12 +200,6 @@ meter_provider:
             # Configure port.
             # If omitted or null, 9464 is used.
             port: 9464
-            # Configure Prometheus Exporter to produce metrics without a unit suffix or UNIT metadata.
-            # If omitted or null, false is used.
-            without_units: false
-            # Configure Prometheus Exporter to produce metrics without a type suffix.
-            # If omitted or null, false is used.
-            without_type_suffix: false
             # Configure Prometheus Exporter to produce metrics without a scope info metric.
             # If omitted or null, false is used.
             without_scope_info: false
@@ -225,6 +219,15 @@ meter_provider:
               # If omitted, .included resource attributes are included.
               excluded:
                 - "service.attr1"
+            # Configure how Prometheus metrics are exposed. Values include:
+            #
+            #  * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.
+            #  * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.
+            #  * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.
+            #  * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.
+            #
+            # If omitted or null, UnderscoreEscapingWithSuffixes is used.
+            translation_strategy: UnderscoreEscapingWithSuffixes
         # Configure metric producers.
         producers:
           - # Configure metric producer to be opencensus.
@@ -459,7 +462,7 @@ meter_provider:
         meter_version: 1.0.0
         # Configure meter schema url selection criteria.
         # If omitted or null, all meter schema URLs match.
-        meter_schema_url: https://opentelemetry.io/schemas/1.30.0
+        meter_schema_url: https://opentelemetry.io/schemas/1.32.0
       # Configure view stream.
       stream:
         # Configure metric name of the resulting stream(s).
@@ -557,18 +560,6 @@ propagator:
   # Built-in propagator identifiers include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party identifiers include: xray.
   # If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.
   composite_list: "tracecontext,baggage,b3,b3multi,jaeger,ottrace,xray"
-# Configure response propagators.
-# If omitted, a noop response propagator is used.
-response_propagator/development:
-  # Configure the experimental response propagators in the composite experimental response propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.
-  # Built-in experimental response propagator keys include: N/A. Known third party keys include: servertiming, traceresponse.
-  # If the resolved list of experimental response propagators (from .composite and .composite_list) is empty, a noop response propagator is used.
-  composite:
-  # Configure the experimental response propagators in the composite experimental response propagator. Entries are appended to .composite with duplicates filtered out.
-  # The value is a comma separated list of experimental response propagator identifiers matching the format of OTEL_EXPERIMENTAL_RESPONSE_PROPAGATORS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
-  # Built-in experimental propagator identifiers include: N/A. Known third party identifiers include: servertiming, traceresponse.
-  # If the resolved list of experimental propagators (from .composite and .composite_list) is empty, a noop response propagator is used.
-  composite_list: "servertiming,traceresponse"
 # Configure tracer provider.
 # If omitted, a noop tracer provider is used.
 tracer_provider:
@@ -851,18 +842,14 @@ resource:
     # Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language.
     # If omitted or null, no resource detectors are enabled.
     detectors:
-      - # Enable the container resource detector.
-        # Note, the key "container" is an example and detector names may vary by SDK language ecosystem.
+      - # Enable the container resource detector, which populates container.* attributes.
         container:
-      - # Enable the host resource detector.
-        # Note, the key "host" is an example and detector names may vary by SDK language ecosystem.
+      - # Enable the host resource detector, which populates host.* and os.* attributes.
         host:
-      - # Enable the os resource detector.
-        # Note, the key "os" is an example and detector names may vary by SDK language ecosystem.
-        os:
-      - # Enable the process resource detector.
-        # Note, the key "process" is an example and detector names may vary by SDK language ecosystem.
+      - # Enable the process resource detector, which populates process.* attributes.
         process:
+      - # Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.
+        service:
   # Configure resource schema URL.
   # If omitted or null, no schema URL is used.
   schema_url: https://opentelemetry.io/schemas/1.32.0
@@ -960,4 +947,4 @@ instrumentation/development:
   swift:
     # Configure the instrumentation corresponding to key "example".
     example:
-      property: "value"
+      property: "value"
diff --git a/tests/Integration/Config/configurations/minimal.yaml b/tests/Integration/Config/configurations/minimal.yaml
@@ -1,2 +1,2 @@
 # this is the minimal acceptable configuration file
-file_format: '0.4'
+file_format: '1.0-rc.2'
diff --git a/tests/Integration/Config/configurations/php-specific.yaml b/tests/Integration/Config/configurations/php-specific.yaml
@@ -0,0 +1,14 @@
+# This config tests PHP-specific additions to declarative config, which are not defined in the upstream spec.
+file_format: '1.0-rc.2'
+# Configure response propagators.
+# If omitted, a noop response propagator is used.
+response_propagator/development:
+  # Configure the experimental response propagators in the composite experimental response propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.
+  # Built-in experimental response propagator keys include: N/A. Known third party keys include: servertiming, traceresponse.
+  # If the resolved list of experimental response propagators (from .composite and .composite_list) is empty, a noop response propagator is used.
+  composite:
+  # Configure the experimental response propagators in the composite experimental response propagator. Entries are appended to .composite with duplicates filtered out.
+  # The value is a comma separated list of experimental response propagator identifiers matching the format of OTEL_EXPERIMENTAL_RESPONSE_PROPAGATORS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+  # Built-in experimental propagator identifiers include: N/A. Known third party identifiers include: servertiming, traceresponse.
+  # If the resolved list of experimental propagators (from .composite and .composite_list) is empty, a noop response propagator is used.
+  composite_list: "servertiming,traceresponse"
diff --git a/tests/Integration/Config/configurations/propagators-duplicate.yaml b/tests/Integration/Config/configurations/propagators-duplicate.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 propagator:
   composite_list: "tracecontext,tracecontext"
diff --git a/tests/Integration/Config/configurations/resource-default.yaml b/tests/Integration/Config/configurations/resource-default.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 resource:
   schema_url: https://opentelemetry.io/schemas/1.32.0
diff --git a/tests/Integration/Config/configurations/resource-include-exclude.yaml b/tests/Integration/Config/configurations/resource-include-exclude.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 resource:
   schema_url: https://opentelemetry.io/schemas/1.32.0
diff --git a/tests/Integration/Config/configurations/resource.yaml b/tests/Integration/Config/configurations/resource.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 resource:
   schema_url: https://opentelemetry.io/schemas/1.32.0
diff --git a/tests/Unit/SDK/fixtures/otel-sdk.yaml b/tests/Unit/SDK/fixtures/otel-sdk.yaml
@@ -1,4 +1,4 @@
-file_format: '0.4'
+file_format: '1.0-rc.2'
 
 tracer_provider:
   processors:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-file_format: '0.4'`
	`1`	`+file_format: '1.0-rc.2'`
`2`	`2`
`3`	`3`	`propagators:`
`4`	`4`	`composite: [ tracecontext, baggage ]`