config: use OTEL_CONFIG_FILE instead of experimental variable (#1901)

Fixes #1900

Signed-off-by: alex boten <223565+codeboten@users.noreply.github.com>

Author: codeboten

examples/instrumentation/configure_instrumentation_global.php

@@ -13,7 +13,7 @@
  */
 // EXAMPLE_INSTRUMENTATION_SPAN_NAME=test1234 php examples/instrumentation/configure_instrumentation_global.php
 putenv('OTEL_PHP_AUTOLOAD_ENABLED=true');
-putenv('OTEL_EXPERIMENTAL_CONFIG_FILE=examples/instrumentation/otel-sdk.yaml');
+putenv('OTEL_CONFIG_FILE=examples/instrumentation/otel-sdk.yaml');
 
 require __DIR__ . '/../../vendor/autoload.php';
 

src/SDK/Common/Configuration/Defaults.php

@@ -120,6 +120,6 @@ interface Defaults
     public const OTEL_PHP_LOGS_PROCESSOR = 'batch';
     public const OTEL_PHP_LOG_DESTINATION = 'default';
     public const OTEL_PHP_EXPERIMENTAL_AUTO_ROOT_SPAN = 'false';
-    public const OTEL_EXPERIMENTAL_CONFIG_FILE = 'sdk-config.yaml';
+    public const OTEL_CONFIG_FILE = 'sdk-config.yaml';
     public const OTEL_EXPERIMENTAL_RESPONSE_PROPAGATORS = 'none';
 }

src/SDK/Common/Configuration/Variables.php

@@ -141,6 +141,6 @@ interface Variables
     public const OTEL_PHP_DISABLED_INSTRUMENTATIONS = 'OTEL_PHP_DISABLED_INSTRUMENTATIONS';
     public const OTEL_PHP_EXCLUDED_URLS = 'OTEL_PHP_EXCLUDED_URLS';
     public const OTEL_PHP_EXPERIMENTAL_AUTO_ROOT_SPAN = 'OTEL_PHP_EXPERIMENTAL_AUTO_ROOT_SPAN';
-    public const OTEL_EXPERIMENTAL_CONFIG_FILE = 'OTEL_EXPERIMENTAL_CONFIG_FILE';
+    public const OTEL_CONFIG_FILE = 'OTEL_CONFIG_FILE';
     public const OTEL_EXPERIMENTAL_RESPONSE_PROPAGATORS = 'OTEL_EXPERIMENTAL_RESPONSE_PROPAGATORS';
 }

src/SDK/SdkAutoloader.php

@@ -63,7 +63,7 @@ public static function autoload(): bool
         if (!self::isEnabled() || self::isExcludedUrl()) {
             return false;
         }
-        if (Configuration::has(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE)) {
+        if (Configuration::has(Variables::OTEL_CONFIG_FILE)) {
             if (!class_exists(SdkConfiguration::class)) {
                 throw new RuntimeException('File-based configuration requires open-telemetry/sdk-configuration');
             }
@@ -129,7 +129,7 @@ private static function environmentBasedInitializer(Configurator $configurator):
      */
     private static function fileBasedInitializer(Configurator $configurator): Configurator
     {
-        $file = Configuration::getString(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE);
+        $file = Configuration::getString(Variables::OTEL_CONFIG_FILE);
         $config = SdkConfiguration::parseFile($file);
 
         //disable hook manager during SDK to avoid autoinstrumenting SDK exporters.
@@ -160,8 +160,8 @@ private static function fileBasedInitializer(Configurator $configurator): Config
      */
     private static function registerInstrumentations(): void
     {
-        $files = Configuration::has(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE)
-            ? Configuration::getList(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE)
+        $files = Configuration::has(Variables::OTEL_CONFIG_FILE)
+            ? Configuration::getList(Variables::OTEL_CONFIG_FILE)
             : [];
         if (class_exists(SdkInstrumentation::class) && $files) {
             $configuration = SdkInstrumentation::parseFile($files)->create();

tests/Unit/SDK/SdkAutoloaderTest.php

@@ -163,7 +163,7 @@ public function test_autoload_from_config_file(): void
     {
         $this->logger->expects($this->never())->method('log')->with($this->equalTo(LogLevel::ERROR));
         $this->setEnvironmentVariable(Variables::OTEL_PHP_AUTOLOAD_ENABLED, 'true');
-        $this->setEnvironmentVariable(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE, __DIR__ . '/fixtures/otel-sdk.yaml');
+        $this->setEnvironmentVariable(Variables::OTEL_CONFIG_FILE, __DIR__ . '/fixtures/otel-sdk.yaml');
 
         $this->assertTrue(SdkAutoloader::autoload());
         $this->assertNotInstanceOf(NoopTracerProvider::class, Globals::tracerProvider());
@@ -176,7 +176,7 @@ public function test_autoload_from_config_file(): void
     public function test_autoload_with_late_globals_initializer(): void
     {
         $this->setEnvironmentVariable(Variables::OTEL_PHP_AUTOLOAD_ENABLED, 'true');
-        $this->setEnvironmentVariable(Variables::OTEL_EXPERIMENTAL_CONFIG_FILE, __DIR__ . '/fixtures/otel-sdk.yaml');
+        $this->setEnvironmentVariable(Variables::OTEL_CONFIG_FILE, __DIR__ . '/fixtures/otel-sdk.yaml');
         $this->assertTrue(SdkAutoloader::autoload());
         //SDK is configured, but globals have not been initialized yet, so we can add more initializers
         $propagator = $this->createMock(TextMapPropagatorInterface::class);