use boolean, use without_scope_info_metric in declarative config

Author: zeitlinger

exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/Otel2PrometheusConverter.java

@@ -82,7 +82,7 @@ final class Otel2PrometheusConverter {
   private static final long NANOS_PER_MILLISECOND = TimeUnit.MILLISECONDS.toNanos(1);
   static final int MAX_CACHE_SIZE = 10;
 
-  private final OtelScopeMode otelScopeMode;
+  private final boolean otelScopeInfoMetricEnabled;
   @Nullable private final Predicate<String> allowedResourceAttributesFilter;
 
   /**
@@ -94,14 +94,15 @@ final class Otel2PrometheusConverter {
   /**
    * Constructor with feature flag parameter.
    *
-   * @param otelScopeMode enable generation of the OpenTelemetry instrumentation scope info metric
-   *     and labels.
+   * @param otelScopeInfoMetricEnabled enable generation of the OpenTelemetry instrumentation scope
+   *     info metric and labels.
    * @param allowedResourceAttributesFilter if not {@code null}, resource attributes with keys
    *     matching this predicate will be added as labels on each exported metric
    */
   Otel2PrometheusConverter(
-      OtelScopeMode otelScopeMode, @Nullable Predicate<String> allowedResourceAttributesFilter) {
-    this.otelScopeMode = otelScopeMode;
+      boolean otelScopeInfoMetricEnabled,
+      @Nullable Predicate<String> allowedResourceAttributesFilter) {
+    this.otelScopeInfoMetricEnabled = otelScopeInfoMetricEnabled;
     this.allowedResourceAttributesFilter = allowedResourceAttributesFilter;
     this.resourceAttributesToAllowedKeysCache =
         allowedResourceAttributesFilter != null
@@ -125,15 +126,15 @@ MetricSnapshots convert(@Nullable Collection<MetricData> metricDataCollection) {
       if (resource == null) {
         resource = metricData.getResource();
       }
-      if (otelScopeMode.isScopeInfoEnabled()
+      if (otelScopeInfoMetricEnabled
           && !metricData.getInstrumentationScopeInfo().getAttributes().isEmpty()) {
         scopes.add(metricData.getInstrumentationScopeInfo());
       }
     }
     if (resource != null) {
       putOrMerge(snapshotsByName, makeTargetInfo(resource));
     }
-    if (otelScopeMode.isScopeInfoEnabled() && !scopes.isEmpty()) {
+    if (otelScopeInfoMetricEnabled && !scopes.isEmpty()) {
       putOrMerge(snapshotsByName, makeScopeInfo(scopes));
     }
     return new MetricSnapshots(snapshotsByName.values());

exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/OtelScopeMode.java

@@ -42,7 +42,7 @@ public final class PrometheusHttpServer implements MetricReader {
 
   private final String host;
   private final int port;
-  private final OtelScopeMode otelScopeMode;
+  private final boolean otelScopeInfoMetricEnabled;
   @Nullable private final Predicate<String> allowedResourceAttributesFilter;
   private final MemoryMode memoryMode;
   private final DefaultAggregationSelector defaultAggregationSelector;
@@ -72,21 +72,21 @@ public static PrometheusHttpServerBuilder builder() {
       int port,
       @Nullable ExecutorService executor,
       PrometheusRegistry prometheusRegistry,
-      OtelScopeMode otelScopeMode,
+      boolean otelScopeInfoMetricEnabled,
       @Nullable Predicate<String> allowedResourceAttributesFilter,
       MemoryMode memoryMode,
       @Nullable HttpHandler defaultHandler,
       DefaultAggregationSelector defaultAggregationSelector,
       @Nullable Authenticator authenticator) {
     this.host = host;
     this.port = port;
-    this.otelScopeMode = otelScopeMode;
+    this.otelScopeInfoMetricEnabled = otelScopeInfoMetricEnabled;
     this.allowedResourceAttributesFilter = allowedResourceAttributesFilter;
     this.memoryMode = memoryMode;
     this.defaultAggregationSelector = defaultAggregationSelector;
     this.builder = builder;
     this.prometheusMetricReader =
-        new PrometheusMetricReader(otelScopeMode, allowedResourceAttributesFilter);
+        new PrometheusMetricReader(otelScopeInfoMetricEnabled, allowedResourceAttributesFilter);
     this.prometheusRegistry = prometheusRegistry;
     prometheusRegistry.register(prometheusMetricReader);
     // When memory mode is REUSABLE_DATA, concurrent reads lead to data corruption. To prevent this,
@@ -171,7 +171,7 @@ public String toString() {
     StringJoiner joiner = new StringJoiner(",", "PrometheusHttpServer{", "}");
     joiner.add("host=" + host);
     joiner.add("port=" + port);
-    joiner.add("otelScopeMode=" + otelScopeMode);
+    joiner.add("otelScopeInfoMetricEnabled=" + otelScopeInfoMetricEnabled);
     joiner.add("allowedResourceAttributesFilter=" + allowedResourceAttributesFilter);
     joiner.add("memoryMode=" + memoryMode);
     joiner.add(

exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/PrometheusHttpServer.java

@@ -30,7 +30,7 @@ public final class PrometheusHttpServerBuilder {
   private String host = DEFAULT_HOST;
   private int port = DEFAULT_PORT;
   private PrometheusRegistry prometheusRegistry = new PrometheusRegistry();
-  private OtelScopeMode otelScopeMode = OtelScopeMode.LABELS_AND_SCOPE_INFO;
+  private boolean otelScopeInfoMetricEnabled = true;
   @Nullable private Predicate<String> allowedResourceAttributesFilter;
   @Nullable private ExecutorService executor;
   private MemoryMode memoryMode = DEFAULT_MEMORY_MODE;
@@ -45,7 +45,7 @@ public final class PrometheusHttpServerBuilder {
     this.host = builder.host;
     this.port = builder.port;
     this.prometheusRegistry = builder.prometheusRegistry;
-    this.otelScopeMode = builder.otelScopeMode;
+    this.otelScopeInfoMetricEnabled = builder.otelScopeInfoMetricEnabled;
     this.allowedResourceAttributesFilter = builder.allowedResourceAttributesFilter;
     this.executor = builder.executor;
     this.memoryMode = builder.memoryMode;
@@ -83,10 +83,11 @@ public PrometheusHttpServerBuilder setPrometheusRegistry(PrometheusRegistry prom
     return this;
   }
 
-  /** Set if the {@code otel_scope_*} attributes are generated. Default is {@code true}. */
+  /** Set if the {@code otel_scope_info} metric is emitted. Default is {@code true}. */
   @SuppressWarnings("UnusedReturnValue")
-  public PrometheusHttpServerBuilder setOtelScopeMode(OtelScopeMode otelScopeMode) {
-    this.otelScopeMode = otelScopeMode;
+  public PrometheusHttpServerBuilder setOtelScopeInfoMetricEnabled(
+      boolean otelScopeInfoMetricEnabled) {
+    this.otelScopeInfoMetricEnabled = otelScopeInfoMetricEnabled;
     return this;
   }
 
@@ -176,7 +177,7 @@ public PrometheusHttpServer build() {
         port,
         executor,
         prometheusRegistry,
-        otelScopeMode,
+        otelScopeInfoMetricEnabled,
         allowedResourceAttributesFilter,
         memoryMode,
         defaultHandler,

exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/PrometheusHttpServerBuilder.java

@@ -28,24 +28,12 @@ public class PrometheusMetricReader implements MetricReader, MultiCollector {
   private volatile CollectionRegistration collectionRegistration = CollectionRegistration.noop();
   private final Otel2PrometheusConverter converter;
 
-  /**
-   * This constructor is deprecated and will be removed in a future release.
-   *
-   * @deprecated use {@link PrometheusMetricReader#PrometheusMetricReader(OtelScopeMode, Predicate)}
-   *     instead.
-   */
-  @SuppressWarnings("unused")
-  @Deprecated
-  public PrometheusMetricReader(
-      boolean otelScopeEnabled, @Nullable Predicate<String> allowedResourceAttributesFilter) {
-    this(OtelScopeMode.LABELS_AND_SCOPE_INFO, allowedResourceAttributesFilter);
-  }
-
   // TODO: refactor to public static create or builder pattern to align with project style
-  /** See {@link Otel2PrometheusConverter#Otel2PrometheusConverter(OtelScopeMode, Predicate)}. */
   public PrometheusMetricReader(
-      OtelScopeMode otelScopeMode, @Nullable Predicate<String> allowedResourceAttributesFilter) {
-    this.converter = new Otel2PrometheusConverter(otelScopeMode, allowedResourceAttributesFilter);
+      boolean otelScopeInfoMetricEnabled,
+      @Nullable Predicate<String> allowedResourceAttributesFilter) {
+    this.converter =
+        new Otel2PrometheusConverter(otelScopeInfoMetricEnabled, allowedResourceAttributesFilter);
   }
 
   @Override

exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/PrometheusMetricReader.java

@@ -6,7 +6,6 @@
 package io.opentelemetry.exporter.prometheus.internal;
 
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
-import io.opentelemetry.exporter.prometheus.OtelScopeMode;
 import io.opentelemetry.exporter.prometheus.PrometheusHttpServer;
 import io.opentelemetry.exporter.prometheus.PrometheusHttpServerBuilder;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
@@ -46,9 +45,9 @@ public MetricReader create(DeclarativeConfigProperties config) {
       prometheusBuilder.setHost(host);
     }
 
-    Boolean withoutScopeInfo = config.getBoolean("without_scope_info");
-    if (Boolean.TRUE.equals(withoutScopeInfo)) {
-      prometheusBuilder.setOtelScopeMode(OtelScopeMode.LABELS_ONLY);
+    Boolean withoutScopeInfo = config.getBoolean("without_scope_info_metric");
+    if (withoutScopeInfo != null) {
+      prometheusBuilder.setOtelScopeInfoMetricEnabled(!withoutScopeInfo);
     }
 
     DeclarativeConfigProperties withResourceConstantLabels =

exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusComponentProvider.java

@@ -72,7 +72,7 @@ class Otel2PrometheusConverterTest {
 
   private final Otel2PrometheusConverter converter =
       new Otel2PrometheusConverter(
-          OtelScopeMode.LABELS_AND_SCOPE_INFO, /* allowedResourceAttributesFilter= */ null);
+          /* otelScopeInfoMetricEnabled */ true, /* allowedResourceAttributesFilter= */ null);
 
   @ParameterizedTest
   @MethodSource("metricMetadataArgs")
@@ -203,7 +203,7 @@ void resourceAttributesAddition(
 
     Otel2PrometheusConverter converter =
         new Otel2PrometheusConverter(
-            OtelScopeMode.LABELS_AND_SCOPE_INFO, allowedResourceAttributesFilter);
+            /* otelScopeInfoMetricEnabled */ true, allowedResourceAttributesFilter);
 
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     MetricSnapshots snapshots = converter.convert(Collections.singletonList(metricData));
@@ -504,7 +504,7 @@ void validateCacheIsBounded() {
 
     Otel2PrometheusConverter otel2PrometheusConverter =
         new Otel2PrometheusConverter(
-            OtelScopeMode.LABELS_AND_SCOPE_INFO,
+            /* otelScopeInfoMetricEnabled */ true,
             /* allowedResourceAttributesFilter= */ countPredicate);
 
     // Create 20 different metric data objects with 2 different resource attributes;

exporters/prometheus/src/test/java/io/opentelemetry/exporter/prometheus/Otel2PrometheusConverterTest.java

@@ -413,7 +413,7 @@ void stringRepresentation() {
             "PrometheusHttpServer{"
                 + "host=localhost,"
                 + "port=0,"
-                + "otelScopeMode=LABELS_AND_SCOPE_INFO,"
+                + "otelScopeInfoMetricEnabled=true,"
                 + "allowedResourceAttributesFilter=null,"
                 + "memoryMode=REUSABLE_DATA,"
                 + "defaultAggregationSelector=DefaultAggregationSelector{COUNTER=default, UP_DOWN_COUNTER=default, HISTOGRAM=default, OBSERVABLE_COUNTER=default, OBSERVABLE_UP_DOWN_COUNTER=default, OBSERVABLE_GAUGE=default, GAUGE=default}"
@@ -528,7 +528,7 @@ void toBuilder() {
     PrometheusHttpServerBuilder builder = PrometheusHttpServer.builder();
     builder.setHost("localhost");
     builder.setPort(1234);
-    builder.setOtelScopeMode(OtelScopeMode.LABELS_ONLY);
+    builder.setOtelScopeInfoMetricEnabled(false);
 
     Predicate<String> resourceAttributesFilter = s -> false;
     builder.setAllowedResourceAttributesFilter(resourceAttributesFilter);
@@ -555,7 +555,7 @@ public Result authenticate(HttpExchange exchange) {
         .isInstanceOf(PrometheusHttpServerBuilder.class)
         .hasFieldOrPropertyWithValue("host", "localhost")
         .hasFieldOrPropertyWithValue("port", 1234)
-        .hasFieldOrPropertyWithValue("otelScopeMode", OtelScopeMode.LABELS_ONLY)
+        .hasFieldOrPropertyWithValue("otelScopeInfoMetricEnabled", false)
         .hasFieldOrPropertyWithValue("allowedResourceAttributesFilter", resourceAttributesFilter)
         .hasFieldOrPropertyWithValue("executor", executor)
         .hasFieldOrPropertyWithValue("prometheusRegistry", prometheusRegistry)

exporters/prometheus/src/test/java/io/opentelemetry/exporter/prometheus/PrometheusHttpServerTest.java

@@ -63,7 +63,7 @@ void setUp() {
     this.createdTimestamp = convertTimestamp(testClock.now());
     this.reader =
         new PrometheusMetricReader(
-            OtelScopeMode.LABELS_AND_SCOPE_INFO, /* allowedResourceAttributesFilter= */ null);
+            /* otelScopeInfoMetricEnabled */ true, /* allowedResourceAttributesFilter= */ null);
     this.meter =
         SdkMeterProvider.builder()
             .setClock(testClock)
@@ -779,7 +779,7 @@ void exponentialHistogramBucketConversion() {
       int prometheusScale = Math.min(otelScale, 8);
       PrometheusMetricReader reader =
           new PrometheusMetricReader(
-              OtelScopeMode.LABELS_AND_SCOPE_INFO, /* allowedResourceAttributesFilter= */ null);
+              /* otelScopeInfoMetricEnabled */ true, /* allowedResourceAttributesFilter= */ null);
       Meter meter =
           SdkMeterProvider.builder()
               .registerMetricReader(reader)
@@ -1033,7 +1033,7 @@ void otelScopeComplete() throws IOException {
   void otelScopeLabelsOnly() throws IOException {
     PrometheusMetricReader reader =
         new PrometheusMetricReader(
-            OtelScopeMode.LABELS_ONLY, /* allowedResourceAttributesFilter= */ null);
+            /* otelScopeInfoMetricEnabled */ false, /* allowedResourceAttributesFilter= */ null);
     Meter meter =
         SdkMeterProvider.builder()
             .setClock(testClock)
@@ -1064,7 +1064,7 @@ void otelScopeLabelsOnly() throws IOException {
   void addResourceAttributesWorks() throws IOException {
     PrometheusMetricReader reader =
         new PrometheusMetricReader(
-            OtelScopeMode.LABELS_AND_SCOPE_INFO,
+            /* otelScopeInfoMetricEnabled */ true,
             /* allowedResourceAttributesFilter= */ Predicates.is("cluster"));
     Meter meter =
         SdkMeterProvider.builder()

exporters/prometheus/src/test/java/io/opentelemetry/exporter/prometheus/PrometheusMetricReaderTest.java

@@ -16,7 +16,6 @@
 import io.github.netmikey.logunit.api.LogCapturer;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
-import io.opentelemetry.exporter.prometheus.OtelScopeMode;
 import io.opentelemetry.exporter.prometheus.PrometheusHttpServer;
 import io.opentelemetry.internal.testing.CleanupExtension;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
@@ -166,7 +165,7 @@ void create_PullPrometheusConfigured() throws IOException {
         PrometheusHttpServer.builder()
             .setHost("localhost")
             .setPort(port)
-            .setOtelScopeMode(OtelScopeMode.LABELS_ONLY)
+            .setOtelScopeInfoMetricEnabled(false)
             .setAllowedResourceAttributesFilter(
                 IncludeExcludePredicate.createPatternMatching(
                     singletonList("foo"), singletonList("bar")))