Declarative config 1.0 (#8123)

Author: jack-berg

integration-tests/graal-incubating/src/test/java/io/opentelemetry/integrationtests/graal/IncubatingApiTests.java

@@ -109,7 +109,7 @@ void parseDeclarativeConfiguration() {
     // make sure to test enums too: "instrument_type: histogram"
     String string =
         """
-      file_format: "1.0-rc.1"
+      file_format: "1.0"
       tracer_provider:
         processors:
           - batch:

sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java

@@ -579,15 +579,18 @@ private static AutoConfiguredOpenTelemetrySdk maybeConfigureFromFile(
       }
     }
 
-    String otelConfigFile = config.getString("otel.config.file");
-    if (otelConfigFile != null && !otelConfigFile.isEmpty()) {
-      logger.warning(
-          "otel.config.file was set, but has been replaced with otel.experimental.config.file");
+    String configurationFile = config.getString("otel.config.file");
+    if (configurationFile == null || configurationFile.isEmpty()) {
+      configurationFile = config.getString("otel.experimental.config.file");
+      if (configurationFile == null || configurationFile.isEmpty()) {
+        logger.warning(
+            "otel.experimental.config.file is deprecated and will be removed after 1.62.0 release. Please use otel.config.file instead.");
+      }
     }
-    String configurationFile = config.getString("otel.experimental.config.file");
     if (configurationFile == null || configurationFile.isEmpty()) {
       return null;
     }
+
     if (!INCUBATOR_AVAILABLE) {
       throw new ConfigurationException(
           "Cannot autoconfigure from config file without opentelemetry-sdk-extension-incubator on the classpath");

sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationTest.java

@@ -23,7 +23,7 @@ class DeclarativeConfigurationTest {
   @Test
   void configFile(@TempDir Path tempDir) throws IOException {
     String yaml =
-        "file_format: \"1.0-rc.1\"\n"
+        "file_format: \"1.0\"\n"
             + "resource:\n"
             + "  attributes:\n"
             + "    - name: service.name\n"
@@ -37,7 +37,7 @@ void configFile(@TempDir Path tempDir) throws IOException {
     Files.write(path, yaml.getBytes(StandardCharsets.UTF_8));
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", path.toString()));
+            Collections.singletonMap("otel.config.file", path.toString()));
 
     assertThatThrownBy(() -> AutoConfiguredOpenTelemetrySdk.builder().setConfig(config).build())
         .isInstanceOf(ConfigurationException.class)

sdk-extensions/autoconfigure/src/testDeclarativeConfigSpi/java/io/opentelemetry/sdk/autoconfigure/TestDeclarativeConfigurationProvider.java

@@ -15,7 +15,7 @@ public class TestDeclarativeConfigurationProvider implements DeclarativeConfigur
   @Override
   public OpenTelemetryConfigurationModel getConfigurationModel() {
     String yaml =
-        "file_format: \"1.0-rc.1\"\n"
+        "file_format: \"1.0\"\n"
             + "resource:\n"
             + "  detection/development:\n"
             + "    detectors:\n"

sdk-extensions/autoconfigure/src/testIncubating/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationTest.java

@@ -61,7 +61,7 @@ class DeclarativeConfigurationTest {
   @BeforeEach
   void setup() throws IOException {
     String yaml =
-        "file_format: \"1.0-rc.1\"\n"
+        "file_format: \"1.0\"\n"
             + "resource:\n"
             + "  attributes:\n"
             + "    - name: service.name\n"
@@ -94,15 +94,15 @@ void configFile_fileNotFound() {
                 AutoConfiguredOpenTelemetrySdk.builder()
                     .setConfig(
                         DefaultConfigProperties.createFromMap(
-                            Collections.singletonMap("otel.experimental.config.file", "foo")))
+                            Collections.singletonMap("otel.config.file", "foo")))
                     .build())
         .isInstanceOf(ConfigurationException.class)
         .hasMessageContaining("Configuration file not found");
 
     assertThatCode(
             () ->
                 AutoConfiguredOpenTelemetrySdk.builder()
-                    .addPropertiesSupplier(() -> singletonMap("otel.experimental.config.file", ""))
+                    .addPropertiesSupplier(() -> singletonMap("otel.config.file", ""))
                     .addPropertiesSupplier(() -> singletonMap("otel.sdk.disabled", "true"))
                     .build())
         .doesNotThrowAnyException();
@@ -112,7 +112,7 @@ void configFile_fileNotFound() {
   void configFile_Valid() {
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", configFilePath.toString()));
+            Collections.singletonMap("otel.config.file", configFilePath.toString()));
     AutoConfiguredOpenTelemetrySdkBuilder builder = spy(AutoConfiguredOpenTelemetrySdk.builder());
     Thread thread = new Thread();
     doReturn(thread).when(builder).shutdownHook(any());
@@ -151,7 +151,7 @@ void configFile_setComponentLoader() {
         ComponentLoader.forClassLoader(DeclarativeConfigurationTest.class.getClassLoader());
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", configFilePath.toString()));
+            Collections.singletonMap("otel.config.file", configFilePath.toString()));
 
     AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk =
         AutoConfiguredOpenTelemetrySdk.builder()
@@ -172,7 +172,7 @@ void configFile_setComponentLoader() {
   void configFile_NoShutdownHook() {
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", configFilePath.toString()));
+            Collections.singletonMap("otel.config.file", configFilePath.toString()));
     AutoConfiguredOpenTelemetrySdkBuilder builder = spy(AutoConfiguredOpenTelemetrySdk.builder());
 
     AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk =
@@ -185,7 +185,7 @@ void configFile_NoShutdownHook() {
   @Test
   void configFile_Error(@TempDir Path tempDir) throws IOException {
     String yaml =
-        "file_format: \"1.0-rc.1\"\n"
+        "file_format: \"1.0\"\n"
             + "resource:\n"
             + "  attributes:\n"
             + "    - name: service.name\n"
@@ -199,7 +199,7 @@ void configFile_Error(@TempDir Path tempDir) throws IOException {
     Files.write(path, yaml.getBytes(StandardCharsets.UTF_8));
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", path.toString()));
+            Collections.singletonMap("otel.config.file", path.toString()));
 
     assertThatThrownBy(() -> AutoConfiguredOpenTelemetrySdk.builder().setConfig(config).build())
         .isInstanceOf(ConfigurationException.class)
@@ -211,7 +211,7 @@ void configFile_Error(@TempDir Path tempDir) throws IOException {
   void configFile_ConfigProvider() {
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", configFilePath.toString()));
+            Collections.singletonMap("otel.config.file", configFilePath.toString()));
 
     AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk =
         AutoConfiguredOpenTelemetrySdk.builder().setConfig(config).setResultAsGlobal().build();

sdk-extensions/autoconfigure/src/testIncubating/java/io/opentelemetry/sdk/autoconfigure/FullDeclarativeConfigTest.java

@@ -129,7 +129,7 @@ void setUp(@TempDir Path tempDir) throws IOException {
 
     String endpoint = "http://localhost:" + server.httpPort();
     String yaml =
-        "file_format: \"1.0-rc.1\"\n"
+        "file_format: \"1.0\"\n"
             + "resource:\n"
             + "  attributes:\n"
             + "    - name: service.name\n"
@@ -178,7 +178,7 @@ void setUp(@TempDir Path tempDir) throws IOException {
     GlobalOpenTelemetry.resetForTest();
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
-            Collections.singletonMap("otel.experimental.config.file", path.toString()));
+            Collections.singletonMap("otel.config.file", path.toString()));
     openTelemetrySdk =
         AutoConfiguredOpenTelemetrySdk.builder()
             .setConfig(config)

sdk-extensions/incubator/README.md

@@ -12,14 +12,14 @@ Usage:
 File yamlConfigFile = new File("/path/to/config.yaml");
 OpenTelemetrySdk openTelemetrySdk;
 try (FileInputStream yamlConfigFileInputStream = new FileInputStream("/path/to/config.yaml")) {
-  openTelemetrySdk = FileConfiguration.parseAndCreate(yamlConfigFileInputStream);
+  openTelemetrySdk = DeclarativeConfiguration.parseAndCreate(yamlConfigFileInputStream);
 }
 // ...proceed with application after successful initialization of OpenTelemetrySdk
 ```
 
 Notes:
 * Environment variable substitution is supported as [defined in the spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/data-model.md#environment-variable-substitution)
-* Currently, there is no support for the customization (i.e. `AutoConfigurationCustomizerProvider`) SPIs defined in [opentelemetry-sdk-extension-autoconfigure-spi](../autoconfigure-spi).
+* Customization is limited to customizing the in-memory config model, or exporters. See `DeclarativeConfigurationCustomizer` SPI for details.
 * Custom SDK extension components which reference the [ComponentProvider](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentProvider.java) SPI can be referenced in declarative configuration. Supported types include:
   * `Resource`
   * `SpanExporter`
@@ -29,7 +29,7 @@ Notes:
   * `LogRecordProcessor`
   * `TextMapPropagator`
   * `Sampler`
-* You can use declarative configuration with [autoconfigure](https://opentelemetry.io/docs/languages/java/configuration/#declarative-configuration) to specify a configuration file via environment variable, e.g. `OTEL_EXPERIMENTAL_CONFIG_FILE=/path/to/config.yaml`.
+* You can use declarative configuration with [autoconfigure](https://opentelemetry.io/docs/languages/java/configuration/#declarative-configuration) to specify a configuration file via environment variable, e.g. `OTEL_CONFIG_FILE=/path/to/config.yaml`.
 
 ## View File Configuration
 

sdk-extensions/incubator/build.gradle.kts

@@ -57,7 +57,7 @@ dependencies {
 // 6. deleteJs2pTmp - delete tmp directory
 // ... proceed with normal sourcesJar, compileJava, etc
 
-val configurationTag = "1.0.0-rc.3"
+val configurationTag = "1.0.0"
 val configurationRef = "refs/tags/v$configurationTag" // Replace with commit SHA to point to experiment with a specific commit
 val configurationRepoZip = "https://github.com/open-telemetry/opentelemetry-configuration/archive/$configurationRef.zip"
 val buildDirectory = layout.buildDirectory.asFile.get()
@@ -212,7 +212,7 @@ tasks {
     environment(
       mapOf(
         // Expose the kitchen sink example file to tests
-        "CONFIG_EXAMPLE_DIR" to "$buildDirectory/configuration/examples/"
+        "CONFIG_REPO_ROOT" to "$buildDirectory/configuration"
       )
     )
   }

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/LoggerProviderFactory.java

@@ -103,7 +103,7 @@ private static class LoggerConfigFactory
     public LoggerConfig create(
         ExperimentalLoggerConfigModel model, DeclarativeConfigContext context) {
       LoggerConfigBuilder configBuilder = LoggerConfig.builder();
-      if (model.getDisabled() != null && model.getDisabled()) {
+      if (model.getEnabled() != null && !model.getEnabled()) {
         configBuilder.setEnabled(false);
       }
       if (model.getTraceBased() != null && model.getTraceBased()) {

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/MeterProviderFactory.java

@@ -112,7 +112,7 @@ private static class MeterConfigFactory
     @Override
     public MeterConfig create(
         ExperimentalMeterConfigModel model, DeclarativeConfigContext context) {
-      if (model.getDisabled() != null && model.getDisabled()) {
+      if (model.getEnabled() != null && !model.getEnabled()) {
         return MeterConfig.disabled();
       }
       return MeterConfig.defaultConfig();