Update exporter environment variable to latest spec's singular forms. (#2499)

* Update exporter environment variable to latest spec's singular forms.

* Fix!

* Use check per test-sets recommendation

* Missed one more

Author: Anuraag Agrawal

sdk-extensions/autoconfigure/build.gradle

@@ -12,7 +12,9 @@ ext.moduleName = "io.opentelemetry.sdk.autoconfigure"
 testSets {
     testConfigError
     testFullConfig
+    testJaeger
     testPrometheus
+    testZipkin
 }
 
 dependencies {
@@ -43,6 +45,10 @@ dependencies {
     testFullConfigImplementation libraries.prometheus_client_httpserver
     testFullConfigImplementation project(':exporters:zipkin')
 
+    testJaegerImplementation project(':exporters:jaeger')
+
+    testZipkinImplementation project(':exporters:zipkin')
+
     testConfigErrorImplementation project(':extensions:trace-propagators')
     testConfigErrorImplementation project(':exporters:jaeger')
     testConfigErrorImplementation project(':exporters:logging')
@@ -59,7 +65,8 @@ dependencies {
 
 testFullConfig {
     environment("OTEL_RESOURCE_ATTRIBUTES", "service.name=test,cat=meow")
-    environment("OTEL_EXPORTER", "otlp,jaeger,zipkin")
+    environment("OTEL_TRACE_EXPORTER", "otlp")
+    environment("OTEL_METRICS_EXPORTER", "otlp")
     environment("OTEL_PROPAGATORS", "tracecontext,baggage,b3,b3multi,jaeger,ottracer,xray,test")
     environment("OTEL_BSP_SCHEDULE_DELAY_MILLIS", "10")
     environment("OTEL_IMR_EXPORT_INTERVAL", "10")
@@ -68,7 +75,19 @@ testFullConfig {
     environment("OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT", "2")
 }
 
+testJaeger {
+    environment("OTEL_TRACE_EXPORTER", "jaeger")
+    environment("OTEL_BSP_SCHEDULE_DELAY_MILLIS", "10")
+}
+
+testZipkin {
+    environment("OTEL_TRACE_EXPORTER", "zipkin")
+    environment("OTEL_BSP_SCHEDULE_DELAY_MILLIS", "10")
+}
+
 testPrometheus {
-    environment("OTEL_EXPORTER", "prometheus")
+    environment("OTEL_METRICS_EXPORTER", "prometheus")
     environment("OTEL_IMR_EXPORT_INTERVAL", "10")
-}
+}
+
+check.dependsOn(testConfigError, testFullConfig, testJaeger, testPrometheus, testZipkin)

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

@@ -14,39 +14,22 @@
 import io.prometheus.client.exporter.HTTPServer;
 import java.io.IOException;
 import java.time.Duration;
-import java.util.Arrays;
 import java.util.Collections;
-import java.util.List;
 
 final class MetricExporterConfiguration {
 
-  static final List<String> RECOGNIZED_NAMES = Arrays.asList("otlp", "otlp_metrics", "prometheus");
-
-  static boolean configureExporter(
-      String name,
-      ConfigProperties config,
-      boolean metricsAlreadyRegistered,
-      SdkMeterProvider meterProvider) {
+  static void configureExporter(
+      String name, ConfigProperties config, SdkMeterProvider meterProvider) {
     switch (name) {
       case "otlp":
       case "otlp_metrics":
-        if (metricsAlreadyRegistered) {
-          throw new ConfigurationException(
-              "Multiple metrics exporters configured. Only one metrics exporter can be "
-                  + "configured at a time.");
-        }
         configureOtlpMetrics(config, meterProvider);
-        return true;
+        return;
       case "prometheus":
-        if (metricsAlreadyRegistered) {
-          throw new ConfigurationException(
-              "Multiple metrics exporters configured. Only one metrics exporter can be "
-                  + "configured at a time.");
-        }
         configurePrometheusMetrics(config, meterProvider);
-        return true;
+        return;
       default:
-        return false;
+        return;
     }
   }
 

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

@@ -12,9 +12,6 @@
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
-import java.util.ArrayList;
-import java.util.LinkedHashSet;
-import java.util.Set;
 
 /**
  * Auto-configuration for the OpenTelemetry SDK. As an alternative to programmatically configuring
@@ -33,38 +30,24 @@ public static OpenTelemetrySdk initialize() {
 
     Resource resource = configureResource(config);
 
-    Set<String> exporterNames =
-        new LinkedHashSet<>(config.getCommaSeparatedValues("otel.exporter"));
-
-    Set<String> unrecognizedExporters = new LinkedHashSet<>(exporterNames);
-    unrecognizedExporters.removeAll(SpanExporterConfiguration.RECOGNIZED_NAMES);
-    unrecognizedExporters.removeAll(MetricExporterConfiguration.RECOGNIZED_NAMES);
-    if (!unrecognizedExporters.isEmpty()) {
-      throw new ConfigurationException(
-          "Unrecognized value for otel.exporter: " + String.join(",", exporterNames));
-    }
-
-    configureMeterProvider(resource, exporterNames, config);
+    configureMeterProvider(resource, config);
 
     SdkTracerProvider tracerProvider =
-        TracerProviderConfiguration.configureTracerProvider(resource, exporterNames, config);
+        TracerProviderConfiguration.configureTracerProvider(resource, config);
 
     return OpenTelemetrySdk.builder()
         .setTracerProvider(tracerProvider)
         .setPropagators(propagators)
         .build();
   }
 
-  private static void configureMeterProvider(
-      Resource resource, Set<String> exporterNames, ConfigProperties config) {
+  private static void configureMeterProvider(Resource resource, ConfigProperties config) {
     SdkMeterProvider meterProvider =
         SdkMeterProvider.builder().setResource(resource).buildAndRegisterGlobal();
 
-    boolean metricsConfigured = false;
-    for (String exporterName : new ArrayList<>(exporterNames)) {
-      metricsConfigured =
-          MetricExporterConfiguration.configureExporter(
-              exporterName, config, metricsConfigured, meterProvider);
+    String exporterName = config.getString("otel.metrics.exporter");
+    if (exporterName != null) {
+      MetricExporterConfiguration.configureExporter(exporterName, config, meterProvider);
     }
   }
 

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

@@ -14,15 +14,10 @@
 import io.opentelemetry.exporter.zipkin.ZipkinSpanExporterBuilder;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import java.time.Duration;
-import java.util.Arrays;
-import java.util.List;
 import javax.annotation.Nullable;
 
 final class SpanExporterConfiguration {
 
-  static final List<String> RECOGNIZED_NAMES =
-      Arrays.asList("otlp", "otlp_span", "jaeger", "zipkin", "logging");
-
   @Nullable
   static SpanExporter configureExporter(String name, ConfigProperties config) {
     switch (name) {

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

@@ -16,15 +16,11 @@
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import io.opentelemetry.sdk.trace.samplers.Sampler;
 import java.time.Duration;
-import java.util.ArrayList;
-import java.util.List;
 import java.util.ServiceLoader;
-import java.util.Set;
 
 final class TracerProviderConfiguration {
 
-  static SdkTracerProvider configureTracerProvider(
-      Resource resource, Set<String> exporterNames, ConfigProperties config) {
+  static SdkTracerProvider configureTracerProvider(Resource resource, ConfigProperties config) {
     SdkTracerProviderBuilder tracerProviderBuilder =
         SdkTracerProvider.builder()
             .setResource(resource)
@@ -37,27 +33,21 @@ static SdkTracerProvider configureTracerProvider(
       configurer.configure(tracerProviderBuilder);
     }
 
-    List<SpanExporter> spanExporters = new ArrayList<>();
-    for (String name : new ArrayList<>(exporterNames)) {
-      SpanExporter exporter = SpanExporterConfiguration.configureExporter(name, config);
+    String exporterName = config.getString("otel.trace.exporter");
+    if (exporterName != null) {
+      SpanExporter exporter = SpanExporterConfiguration.configureExporter(exporterName, config);
       if (exporter != null) {
-        spanExporters.add(exporter);
+        tracerProviderBuilder.addSpanProcessor(configureSpanProcessor(config, exporter));
       }
     }
 
-    if (!spanExporters.isEmpty()) {
-      tracerProviderBuilder.addSpanProcessor(configureSpanProcessor(config, spanExporters));
-    }
-
     SdkTracerProvider tracerProvider = tracerProviderBuilder.build();
     Runtime.getRuntime().addShutdownHook(new Thread(tracerProvider::shutdown));
     return tracerProvider;
   }
 
   // VisibleForTesting
-  static BatchSpanProcessor configureSpanProcessor(
-      ConfigProperties config, List<SpanExporter> exporters) {
-    SpanExporter exporter = SpanExporter.composite(exporters);
+  static BatchSpanProcessor configureSpanProcessor(ConfigProperties config, SpanExporter exporter) {
     BatchSpanProcessorBuilder builder = BatchSpanProcessor.builder(exporter);
 
     Long scheduleDelayMillis = config.getLong("otel.bsp.schedule.delay.millis");

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

@@ -56,7 +56,7 @@ void otlpMetrics() {
     assertThatThrownBy(
             () ->
                 MetricExporterConfiguration.configureExporter(
-                    "otlp", EMPTY, false, SdkMeterProvider.builder().build()))
+                    "otlp", EMPTY, SdkMeterProvider.builder().build()))
         .isInstanceOf(ConfigurationException.class)
         .hasMessageContaining(
             "OTLP Metrics Exporter enabled but opentelemetry-exporter-otlp-metrics not found on "
@@ -68,7 +68,7 @@ void prometheus() {
     assertThatThrownBy(
             () ->
                 MetricExporterConfiguration.configureExporter(
-                    "prometheus", EMPTY, false, SdkMeterProvider.builder().build()))
+                    "prometheus", EMPTY, SdkMeterProvider.builder().build()))
         .isInstanceOf(ConfigurationException.class)
         .hasMessageContaining(
             "Prometheus Metrics Server enabled but opentelemetry-exporter-prometheus not found on "

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

@@ -47,7 +47,7 @@ void configureTracerProvider() {
     // are verified in other test sets like testFullConfig.
     SdkTracerProvider tracerProvider =
         TracerProviderConfiguration.configureTracerProvider(
-            resource, Collections.emptySet(), ConfigProperties.createForTest(properties));
+            resource, ConfigProperties.createForTest(properties));
     try {
       assertThat(tracerProvider.getActiveTraceConfig().getSampler()).isEqualTo(Sampler.alwaysOff());
 
@@ -68,8 +68,7 @@ void configureTracerProvider() {
   @Test
   void configureSpanProcessor_empty() {
     BatchSpanProcessor processor =
-        TracerProviderConfiguration.configureSpanProcessor(
-            EMPTY, Collections.singletonList(exporter));
+        TracerProviderConfiguration.configureSpanProcessor(EMPTY, exporter);
 
     try {
       assertThat(processor)
@@ -105,7 +104,7 @@ void configureSpanProcessor_configured() {
 
     BatchSpanProcessor processor =
         TracerProviderConfiguration.configureSpanProcessor(
-            ConfigProperties.createForTest(properties), Collections.singletonList(exporter));
+            ConfigProperties.createForTest(properties), exporter);
 
     try {
       assertThat(processor)

sdk-extensions/autoconfigure/src/testConfigError/java/io/opentelemetry/sdk/autoconfigure/ConfigErrorTest.java

@@ -25,26 +25,6 @@ class ConfigErrorTest {
   @RegisterExtension
   LogCapturer logs = LogCapturer.create().captureForType(GlobalOpenTelemetry.class);
 
-  @Test
-  @SetSystemProperty(key = "otel.exporter", value = "otlp_metrics,prometheus")
-  void multipleMetricExportersPrometheusThrows() {
-    assertThatThrownBy(OpenTelemetrySdkAutoConfiguration::initialize)
-        .isInstanceOf(ConfigurationException.class)
-        .hasMessage(
-            "Multiple metrics exporters configured. "
-                + "Only one metrics exporter can be configured at a time.");
-  }
-
-  @Test
-  @SetSystemProperty(key = "otel.exporter", value = "prometheus,otlp_metrics")
-  void multipleMetricExportersOtlpThrows() {
-    assertThatThrownBy(OpenTelemetrySdkAutoConfiguration::initialize)
-        .isInstanceOf(ConfigurationException.class)
-        .hasMessage(
-            "Multiple metrics exporters configured. "
-                + "Only one metrics exporter can be configured at a time.");
-  }
-
   @Test
   @SetSystemProperty(key = "otel.propagators", value = "cat")
   void invalidPropagator() {
@@ -53,16 +33,6 @@ void invalidPropagator() {
         .hasMessage("Unrecognized value for otel.propagators: cat");
   }
 
-  @Test
-  @SetSystemProperty(key = "otel.trace.sampler", value = "traceidratio")
-  void missingTraceIdRatio() {
-    assertThatThrownBy(OpenTelemetrySdkAutoConfiguration::initialize)
-        .isInstanceOf(ConfigurationException.class)
-        .hasMessage(
-            "otel.trace.sampler=traceidratio but otel.trace.sampler.arg is not provided. "
-                + "Set otel.trace.sampler.arg to a value in the range [0.0, 1.0].");
-  }
-
   @Test
   @SetSystemProperty(key = "otel.trace.sampler", value = "traceidratio")
   @SetSystemProperty(key = "otel.trace.sampler.arg", value = "bar")
@@ -72,16 +42,6 @@ void invalidTraceIdRatio() {
         .hasMessage("Invalid value for property otel.trace.sampler.arg=bar. Must be a double.");
   }
 
-  @Test
-  @SetSystemProperty(key = "otel.trace.sampler", value = "parentbased_traceidratio")
-  void missingTraceIdRatioWithParent() {
-    assertThatThrownBy(OpenTelemetrySdkAutoConfiguration::initialize)
-        .isInstanceOf(ConfigurationException.class)
-        .hasMessage(
-            "otel.trace.sampler=parentbased_traceidratio but otel.trace.sampler.arg is "
-                + "not provided. Set otel.trace.sampler.arg to a value in the range [0.0, 1.0].");
-  }
-
   @Test
   @SetSystemProperty(key = "otel.trace.sampler", value = "parentbased_traceidratio")
   @SetSystemProperty(key = "otel.trace.sampler.arg", value = "bar")
@@ -100,15 +60,8 @@ void invalidSampler() {
   }
 
   @Test
-  @SetSystemProperty(key = "otel.exporter", value = "otlp,cat,dog")
-  void invalidExporter() {
-    assertThatThrownBy(OpenTelemetrySdkAutoConfiguration::initialize)
-        .isInstanceOf(ConfigurationException.class)
-        .hasMessage("Unrecognized value for otel.exporter: cat,dog");
-  }
-
-  @Test
-  @SetSystemProperty(key = "otel.exporter", value = "bar")
+  @SetSystemProperty(key = "otel.trace.sampler", value = "traceidratio")
+  @SetSystemProperty(key = "otel.trace.sampler.arg", value = "bar")
   void globalOpenTelemetryWhenError() {
     assertThat(GlobalOpenTelemetry.get())
         .isInstanceOf(OpenTelemetrySdk.class)
@@ -121,8 +74,6 @@ void globalOpenTelemetryWhenError() {
             "Error automatically configuring OpenTelemetry SDK. "
                 + "OpenTelemetry will not be enabled.");
     assertThat(log.getLevel()).isEqualTo(Level.ERROR);
-    assertThat(log.getThrowable())
-        .isInstanceOf(ConfigurationException.class)
-        .hasMessage("Unrecognized value for otel.exporter: bar");
+    assertThat(log.getThrowable()).isInstanceOf(ConfigurationException.class);
   }
 }