Allows API packages to specify file-based and env-based config (#1621)

* Move `ComponentProvider` and related classes to API

* Use API `ComponentProvider`

* Use API `ComponentProvider` in tests

* Add `EnvComponentLoader` API

* Add `EnvComponentLoader` example

* Ignore deptrac violations

* Remove namespace from `ComponentProvider` BC layer

* Add API requirement to config package

* Fix/suppress unrelated phpstan errors caused by `google/protobuf` `^4.31`

Author: Nevay

.phan/config.php

@@ -381,6 +381,7 @@
         'vendor/google/protobuf/src',
         'vendor/ramsey/uuid/src',
         'vendor/nyholm/psr7-server/src',
+        'vendor/symfony/config',
     ],
 
     // A list of individual files to include in analysis

composer.json

@@ -126,7 +126,7 @@
             "forward-command": true
         },
         "spi": {
-            "OpenTelemetry\\Config\\SDK\\Configuration\\ComponentProvider": [
+            "OpenTelemetry\\API\\Configuration\\Config\\ComponentProvider": [
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3Multi",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorBaggage",
@@ -180,6 +180,12 @@
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\TextMapPropagatorXray",
                 "OpenTelemetry\\Tests\\Integration\\Config\\ComponentProvider\\Propagator\\TextMapPropagatorOtTrace"
             ],
+            "OpenTelemetry\\API\\Configuration\\ConfigEnv\\EnvComponentLoader": [
+                "OpenTelemetry\\API\\Instrumentation\\Configuration\\General\\ConfigEnv\\EnvComponentLoaderHttpConfig",
+                "OpenTelemetry\\API\\Instrumentation\\Configuration\\General\\ConfigEnv\\EnvComponentLoaderPeerConfig",
+
+                "OpenTelemetry\\Example\\ExampleConfigLoader"
+            ],
             "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\HookManagerInterface": [
               "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\ExtensionHookManager"
             ],

deptrac.baseline.yaml

@@ -6,3 +6,9 @@ deptrac:
       - OpenTelemetry\SDK\Registry
     /src/Extension/Propagator/Jaeger/_register.php:
       - OpenTelemetry\SDK\Registry
+    OpenTelemetry\API\Configuration\Config\ComponentProvider:
+      - Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
+      - Symfony\Component\Config\Definition\Builder\NodeBuilder
+    OpenTelemetry\API\Configuration\Config\ComponentProviderRegistry:
+      - Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
+      - Symfony\Component\Config\Definition\Builder\NodeDefinition

examples/instrumentation/configure_instrumentation.php

@@ -5,11 +5,11 @@
 namespace _;
 
 use Nevay\SPI\ServiceLoader;
+use OpenTelemetry\API\Configuration\Context;
 use OpenTelemetry\API\Globals;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\ExtensionHookManager;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
 use OpenTelemetry\Config\SDK\Configuration;
-use OpenTelemetry\Config\SDK\Configuration\Context;
 use OpenTelemetry\Example\Example;
 use const PHP_EOL;
 

examples/instrumentation/configure_instrumentation_env.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace _;
+
+use OpenTelemetry\Example\Example;
+use const PHP_EOL;
+use function putenv;
+
+/**
+ * This example uses SPI (see root composer.json extra.spi) to configure an example auto-instrumentation from environment variables.
+ */
+// php examples/instrumentation/configure_instrumentation_env.php
+putenv('OTEL_PHP_AUTOLOAD_ENABLED=true');
+putenv('OTEL_PHP_EXAMPLE_INSTRUMENTATION_SPAN_NAME=example span');
+putenv('OTEL_TRACES_EXPORTER=console');
+putenv('OTEL_METRICS_EXPORTER=none');
+putenv('OTEL_LOGS_EXPORTER=none');
+
+require __DIR__ . '/../../vendor/autoload.php';
+
+echo (new Example())->test(), PHP_EOL;

examples/instrumentation/otel-sdk.yaml

@@ -1,4 +1,4 @@
-file_format: '0.3'
+file_format: '0.4'
 
 propagator:
   composite: []

examples/src/ExampleConfig.php

@@ -9,7 +9,7 @@
 final class ExampleConfig implements InstrumentationConfiguration
 {
     public function __construct(
-        public readonly string $spanName,
+        public readonly string $spanName = 'example',
         public readonly bool $enabled = true,
     ) {
     }

examples/src/ExampleConfigLoader.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Example;
+
+use OpenTelemetry\API\Configuration\ConfigEnv\EnvComponentLoader;
+use OpenTelemetry\API\Configuration\ConfigEnv\EnvComponentLoaderRegistry;
+use OpenTelemetry\API\Configuration\ConfigEnv\EnvResolver;
+use OpenTelemetry\API\Configuration\Context;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\InstrumentationConfiguration;
+
+/**
+ * @implements EnvComponentLoader<InstrumentationConfiguration>
+ */
+final class ExampleConfigLoader implements EnvComponentLoader
+{
+    public function load(EnvResolver $env, EnvComponentLoaderRegistry $registry, Context $context): InstrumentationConfiguration
+    {
+        return new ExampleConfig(
+            spanName: $env->string('OTEL_PHP_EXAMPLE_INSTRUMENTATION_SPAN_NAME') ?? 'example',
+        );
+    }
+
+    public function name(): string
+    {
+        return ExampleConfig::class;
+    }
+}

examples/src/ExampleConfigProvider.php

@@ -4,10 +4,10 @@
 
 namespace OpenTelemetry\Example;
 
+use OpenTelemetry\API\Configuration\Config\ComponentProvider;
+use OpenTelemetry\API\Configuration\Config\ComponentProviderRegistry;
+use OpenTelemetry\API\Configuration\Context;
 use OpenTelemetry\API\Instrumentation\AutoInstrumentation\InstrumentationConfiguration;
-use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
-use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
-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;

examples/src/ExampleInstrumentation.php

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