Bump FileBasedConfiguration to 1.0 (#4883)

Co-authored-by: Robert Pająk <pellared@hotmail.com>

Author: ysolomchenko

CHANGELOG.md

@@ -9,6 +9,11 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 
 ### Added
 
+- Add support for file-based configuration file format version `1.0`.
+- Add support for `OTEL_CONFIG_FILE` environment variable for file-based configuration.
+  This variable takes precedence over the deprecated
+  `OTEL_EXPERIMENTAL_CONFIG_FILE` environment variable.
+
 ### Changed
 
 - MongoDB instrumentation is updated to comply with v1.39.0 Semantic Convention
@@ -21,6 +26,9 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 
 ### Deprecated
 
+- `OTEL_EXPERIMENTAL_CONFIG_FILE` environment variable for file-based
+  configuration is deprecated. Use `OTEL_CONFIG_FILE` instead.
+
 ### Removed
 
 ### Fixed

docs/file-based-configuration.md

@@ -17,7 +17,7 @@ By default, the value is false.
 You can also specify the configuration file path (default: `config.yaml`):
 
 ```bash
-OTEL_EXPERIMENTAL_CONFIG_FILE=/path/to/config.yaml
+OTEL_CONFIG_FILE=/path/to/config.yaml
 ```
 
 In your config file you can use environment variables in the format `${ENVIRONMENT_VARIABLE}`
@@ -139,7 +139,7 @@ file-based configuration to include these parameters.
 # The yaml format is documented at
 # <https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema>
 # By default, the latest version is used.
-file_format: "1.0-rc.1"
+file_format: "1.0"
 # Configure if the SDK is disabled or not.
 # If omitted or null, false is used
 disabled: false

docs/nocode-instrumentation.md

@@ -45,7 +45,7 @@ The no-code instrumentation configuration is defined under the
 `no_code/development` section in your YAML configuration file:
 
 ```yaml
-file_format: "1.0-rc.1"
+file_format: "1.0"
 
 instrumentation/development:
   dotnet:

examples/file-based-configuration-files/default-config.yaml

@@ -4,7 +4,7 @@
 # The yaml format is documented at
 # <https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema>
 # By default, the latest version is used.
-file_format: "1.0-rc.1"
+file_format: "1.0"
 
 # Propagator Configuration
 propagator:

examples/file-based-configuration-files/kitchen-sink.yaml

@@ -9,7 +9,7 @@
 # The yaml format is documented at
 # <https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema>
 # By default, the latest version is used.
-file_format: "1.0-rc.1"
+file_format: "1.0"
 # Configure if the SDK is disabled or not.
 # If omitted or null, false is used
 disabled: false

examples/file-based-configuration-files/sdk-migration-config.yaml

@@ -31,7 +31,7 @@
 # The yaml format is documented at
 # <https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema>
 # By default, the latest version is used.
-file_format: "1.0-rc.1"
+file_format: "1.0"
 # Configure if the SDK is disabled or not.
 # If omitted or null, false is used
 # This setting is inverted (if OTEL_DOTNET_AUTO_SETUP_SDK is true, the SDK is disabled)

src/OpenTelemetry.AutoInstrumentation/Configurations/ConfigurationKeys.cs

@@ -78,11 +78,17 @@ public static class FileBasedConfiguration
         /// </summary>
         public const string Enabled = "OTEL_EXPERIMENTAL_FILE_BASED_CONFIGURATION_ENABLED";
 
+        /// <summary>
+        /// Configuration key for the deprecated path to the configuration file.
+        /// Default is <c>"config.yaml"</c>.
+        /// </summary>
+        public const string ExperimentalFileName = "OTEL_EXPERIMENTAL_CONFIG_FILE";
+
         /// <summary>
         /// Configuration key for the path to the configuration file.
         /// Default is <c>"config.yaml"</c>.
         /// </summary>
-        public const string FileName = "OTEL_EXPERIMENTAL_CONFIG_FILE";
+        public const string FileName = "OTEL_CONFIG_FILE";
     }
 
     /// <summary>

src/OpenTelemetry.AutoInstrumentation/Configurations/Settings.cs

@@ -3,6 +3,7 @@
 
 using OpenTelemetry.AutoInstrumentation.Configurations.FileBasedConfiguration;
 using OpenTelemetry.AutoInstrumentation.Configurations.FileBasedConfiguration.Parser;
+using OpenTelemetry.AutoInstrumentation.Logging;
 
 namespace OpenTelemetry.AutoInstrumentation.Configurations;
 
@@ -13,6 +14,7 @@ internal abstract class Settings
 {
     private static readonly bool IsYamlConfigEnabled = Environment.GetEnvironmentVariable(ConfigurationKeys.FileBasedConfiguration.Enabled) == "true";
     private static readonly Lazy<YamlConfiguration> YamlConfiguration = new(ReadYamlConfiguration);
+    private static readonly IOtelLogger Logger = OtelLogging.GetLogger();
 
     public static T FromDefaultSources<T>(bool failFast)
         where T : Settings, new()
@@ -58,7 +60,28 @@ public void LoadFile(YamlConfiguration configuration)
 
     private static YamlConfiguration ReadYamlConfiguration()
     {
-        var configFile = Environment.GetEnvironmentVariable(ConfigurationKeys.FileBasedConfiguration.FileName) ?? "config.yaml";
+        var experimentalConfigFile = Environment.GetEnvironmentVariable(ConfigurationKeys.FileBasedConfiguration.ExperimentalFileName);
+
+        var configFile = Environment.GetEnvironmentVariable(ConfigurationKeys.FileBasedConfiguration.FileName);
+
+        if (!string.IsNullOrEmpty(configFile))
+        {
+            if (!string.IsNullOrEmpty(experimentalConfigFile))
+            {
+                Logger.Warning("Both OTEL_EXPERIMENTAL_CONFIG_FILE (deprecated) and OTEL_CONFIG_FILE are set. " +
+                    "Using OTEL_CONFIG_FILE and ignoring the deprecated variable.");
+            }
+        }
+        else if (!string.IsNullOrEmpty(experimentalConfigFile))
+        {
+            Logger.Warning("OTEL_EXPERIMENTAL_CONFIG_FILE is deprecated. Please use OTEL_CONFIG_FILE instead.");
+            configFile = experimentalConfigFile;
+        }
+        else
+        {
+            configFile = "config.yaml";
+        }
+
         // TODO validate file existence
 
         var config = Parser.ParseYaml<YamlConfiguration>(configFile);

test/OpenTelemetry.AutoInstrumentation.Tests/Configurations/FileBased/Files/NoCodeFile.yaml

@@ -1,3 +1,5 @@
+file_format: "1.0"
+
 instrumentation/development:
   dotnet:
     no_code:

test/OpenTelemetry.AutoInstrumentation.Tests/Configurations/FileBased/Files/TestGeneralFile.yaml

@@ -1,4 +1,4 @@
-file_format: "1.0-rc.1"
+file_format: "1.0"
 disabled: false
 fail_fast: false
 flush_on_unhandled_exception: false