adding config provider

implement recent additions to the otel spec re: config provider. Config provider should return a
ConfigProperties, but we were already returning a ConfigurationRegistry. Added a ConfigProperties
interface for ConfigurationRegistry to implement, which gets us pretty close to spec.
We don't make ConfigProvider globally available, instead passing the ConfigurationRegistry in to
each instrumentation as we register it. The spec allows for this.

Author: brettmc

examples/src/ExampleInstrumentation.php

@@ -5,7 +5,7 @@
 namespace OpenTelemetry\Example;
 
 use Exception;
-use OpenTelemetry\API\Instrumentation\AutoInstrumentation\ConfigurationRegistry;
+use OpenTelemetry\API\Configuration\ConfigProperties;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Context as InstrumentationContext;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManagerInterface;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
@@ -15,7 +15,7 @@
 final class ExampleInstrumentation implements Instrumentation
 {
 
-    public function register(HookManagerInterface $hookManager, ConfigurationRegistry $configuration, InstrumentationContext $context): void
+    public function register(HookManagerInterface $hookManager, ConfigProperties $configuration, InstrumentationContext $context): void
     {
         $config = $configuration->get(ExampleConfig::class) ?? throw new Exception('example instrumentation must be configured');
         if (!$config->enabled) {

src/API/Configuration/ConfigProperties.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\API\Configuration;
+
+interface ConfigProperties
+{
+    public function get(string $id): mixed;
+}

src/API/Configuration/ConfigProviderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\API\Configuration;
+
+interface ConfigProviderInterface
+{
+    public function getInstrumentationConfig(): ConfigProperties;
+}

src/API/Configuration/Noop/NoopConfigProperties.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\API\Configuration\Noop;
+
+use OpenTelemetry\API\Configuration\ConfigProperties;
+
+class NoopConfigProperties implements ConfigProperties
+{
+
+    public function get(string $id): mixed
+    {
+        return null;
+    }
+}

src/API/Configuration/Noop/NoopConfigProvider.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\API\Configuration\Noop;
+
+use OpenTelemetry\API\Configuration\ConfigProperties;
+use OpenTelemetry\API\Configuration\ConfigProviderInterface;
+
+class NoopConfigProvider implements ConfigProviderInterface
+{
+    public function getInstrumentationConfig(): ConfigProperties
+    {
+        return new NoopConfigProperties();
+    }
+}

src/API/Instrumentation/AutoInstrumentation/ConfigurationRegistry.php

@@ -4,7 +4,9 @@
 
 namespace OpenTelemetry\API\Instrumentation\AutoInstrumentation;
 
-final class ConfigurationRegistry
+use OpenTelemetry\API\Configuration\ConfigProperties;
+
+final class ConfigurationRegistry implements ConfigProperties
 {
 
     private array $configurations = [];
@@ -18,6 +20,7 @@ public function add(InstrumentationConfiguration $configuration): self
 
     /**
      * @template C of InstrumentationConfiguration
+     * @psalm-suppress MoreSpecificImplementedParamType
      * @param class-string<C> $id
      * @return C|null
      */

src/SDK/SdkAutoloader.php

@@ -6,6 +6,7 @@
 
 use Nevay\SPI\ServiceLoader;
 use OpenTelemetry\API\Behavior\LogsMessagesTrait;
+use OpenTelemetry\API\Configuration\Noop\NoopConfigProperties;
 use OpenTelemetry\API\Globals;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Context as InstrumentationContext;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
@@ -34,6 +35,7 @@
 use OpenTelemetry\SDK\Trace\SamplerFactory;
 use OpenTelemetry\SDK\Trace\SpanProcessorFactory;
 use OpenTelemetry\SDK\Trace\TracerProviderBuilder;
+use RuntimeException;
 use Throwable;
 
 /**
@@ -49,6 +51,9 @@ public static function autoload(): bool
             return false;
         }
         if (Configuration::has(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE)) {
+            if (!class_exists(SdkConfiguration::class)) {
+                throw new RuntimeException('File-based configuration requires open-telemetry/sdk-configuration');
+            }
             Globals::registerInitializer(fn ($configurator) => self::fileBasedInitializer($configurator));
         } else {
             Globals::registerInitializer(fn ($configurator) => self::environmentBasedInitializer($configurator));
@@ -131,7 +136,11 @@ private static function registerInstrumentations(): void
         $files = Configuration::has(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE)
             ? Configuration::getList(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE)
             : [];
-        $configuration = SdkInstrumentation::parseFile($files)->create();
+        if (class_exists(SdkInstrumentation::class)) {
+            $configuration = SdkInstrumentation::parseFile($files)->create();
+        } else {
+            $configuration = new NoopConfigProperties();
+        }
         $hookManager = self::getHookManager();
         $tracerProvider = self::createLateBindingTracerProvider();
         $meterProvider = self::createLateBindingMeterProvider();
@@ -145,7 +154,6 @@ private static function registerInstrumentations(): void
             } catch (Throwable $t) {
                 self::logError(sprintf('Unable to load instrumentation: %s', $instrumentation::class), ['exception' => $t]);
             }
-
         }
     }
 

src/SDK/composer.json

@@ -49,7 +49,8 @@
     },
     "suggest": {
         "ext-gmp": "To support unlimited number of synchronous metric readers",
-        "ext-mbstring": "To increase performance of string operations"
+        "ext-mbstring": "To increase performance of string operations",
+        "open-telemetry/sdk-configuration": "File-based OpenTelemetry SDK configuration"
     },
     "extra": {
         "branch-alias": {

tests/Unit/API/Configuration/Noop/NoopConfigPropertiesTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Unit\API\Configuration\Noop;
+
+use OpenTelemetry\API\Configuration\Noop\NoopConfigProperties;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(NoopConfigProperties::class)]
+class NoopConfigPropertiesTest extends TestCase
+{
+    public function test_get(): void
+    {
+        $properties = new NoopConfigProperties();
+        $this->assertNull($properties->get('foo'));
+    }
+}

tests/Unit/API/Configuration/Noop/NoopConfigProviderTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Unit\API\Configuration\Noop;
+
+use OpenTelemetry\API\Configuration\Noop\NoopConfigProperties;
+use OpenTelemetry\API\Configuration\Noop\NoopConfigProvider;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(NoopConfigProvider::class)]
+class NoopConfigProviderTest extends TestCase
+{
+    public function test_get_instrumentation_config(): void
+    {
+        $provider = new NoopConfigProvider();
+        $this->assertInstanceOf(NoopConfigProperties::class, $provider->getInstrumentationConfig());
+    }
+}