Prototype support for cardinality limits

Author: jack-berg

sdk-extensions/incubator/build.gradle.kts

@@ -60,8 +60,8 @@ dependencies {
 //  it was needed after 0.3.0 release because file_format in the examples weren't updated prior to the release tag
 // val configurationTag = "0.3.0"
 // val configurationRef = "refs/tags/v$configurationTag" // Replace with commit SHA to point to experiment with a specific commit
-val configurationRef = "bd511a6a16b321a7bb3135fa783dda1fbd40706f"
-val configurationRepoZip = "https://github.com/open-telemetry/opentelemetry-configuration/archive/$configurationRef.zip"
+val configurationRef = "f4c0dc7ce058ded98ef2039e07dbfe9bd2320e82"
+val configurationRepoZip = "https://github.com/jack-berg/opentelemetry-configuration/archive/$configurationRef.zip"
 val buildDirectory = layout.buildDirectory.asFile.get()
 
 val downloadConfigurationSchema by tasks.registering(Download::class) {

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

@@ -0,0 +1,64 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.extension.incubator.fileconfig;
+
+import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.CardinalityLimitsModel;
+import io.opentelemetry.sdk.metrics.export.CardinalityLimitSelector;
+import io.opentelemetry.sdk.metrics.internal.state.MetricStorage;
+import java.io.Closeable;
+import java.util.List;
+import javax.annotation.Nullable;
+
+final class CardinalityLimitsFactory
+    implements Factory<CardinalityLimitsModel, CardinalityLimitSelector> {
+
+  private static final CardinalityLimitsFactory INSTANCE = new CardinalityLimitsFactory();
+
+  private CardinalityLimitsFactory() {}
+
+  static CardinalityLimitsFactory getInstance() {
+    return INSTANCE;
+  }
+
+  @Override
+  public CardinalityLimitSelector create(
+      CardinalityLimitsModel model, SpiHelper spiHelper, List<Closeable> closeables) {
+    int defaultLimit = getOrDefault(model.getDefault(), MetricStorage.DEFAULT_MAX_CARDINALITY);
+    int counterLimit = getOrDefault(model.getCounter(), defaultLimit);
+    int gaugeLimit = getOrDefault(model.getGauge(), defaultLimit);
+    int histogramLimit = getOrDefault(model.getHistogram(), defaultLimit);
+    int observableCounterLimit = getOrDefault(model.getObservableCounter(), defaultLimit);
+    int observableGaugeLimit = getOrDefault(model.getObservableGauge(), defaultLimit);
+    int observableUpDownCounterLimit =
+        getOrDefault(model.getObservableUpDownCounter(), defaultLimit);
+    int upDownCounterLimit = getOrDefault(model.getUpDownCounter(), defaultLimit);
+
+    return instrumentType -> {
+      switch (instrumentType) {
+        case COUNTER:
+          return counterLimit;
+        case UP_DOWN_COUNTER:
+          return upDownCounterLimit;
+        case HISTOGRAM:
+          return histogramLimit;
+        case OBSERVABLE_COUNTER:
+          return observableCounterLimit;
+        case OBSERVABLE_UP_DOWN_COUNTER:
+          return observableUpDownCounterLimit;
+        case OBSERVABLE_GAUGE:
+          return observableGaugeLimit;
+        case GAUGE:
+          return gaugeLimit;
+      }
+      return defaultLimit;
+    };
+  }
+
+  private static int getOrDefault(@Nullable Integer value, int defaultValue) {
+    return value == null ? defaultValue : value;
+  }
+}

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

@@ -15,7 +15,7 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ViewStreamModel;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder;
-import io.opentelemetry.sdk.metrics.export.MetricReader;
+import io.opentelemetry.sdk.metrics.export.CardinalityLimitSelector;
 import java.io.Closeable;
 import java.util.List;
 
@@ -38,10 +38,15 @@ public SdkMeterProviderBuilder create(
     if (readerModels != null) {
       readerModels.forEach(
           readerModel -> {
-            MetricReader metricReader =
+            MetricReaderAndCardinalityLimits readerAndCardinalityLimits =
                 MetricReaderFactory.getInstance().create(readerModel, spiHelper, closeables);
-            if (metricReader != null) {
-              builder.registerMetricReader(metricReader);
+            CardinalityLimitSelector cardinalityLimits =
+                readerAndCardinalityLimits.getCardinalityLimitsSelector();
+            if (cardinalityLimits == null) {
+              builder.registerMetricReader(readerAndCardinalityLimits.getMetricReader());
+            } else {
+              builder.registerMetricReader(
+                  readerAndCardinalityLimits.getMetricReader(), cardinalityLimits);
             }
           });
     }

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

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.extension.incubator.fileconfig;
+
+import com.google.auto.value.AutoValue;
+import io.opentelemetry.sdk.metrics.export.CardinalityLimitSelector;
+import io.opentelemetry.sdk.metrics.export.MetricReader;
+import javax.annotation.Nullable;
+
+@AutoValue
+abstract class MetricReaderAndCardinalityLimits {
+
+  static MetricReaderAndCardinalityLimits create(
+      MetricReader metricReader, @Nullable CardinalityLimitSelector cardinalityLimitSelector) {
+    return new AutoValue_MetricReaderAndCardinalityLimits(metricReader, cardinalityLimitSelector);
+  }
+
+  abstract MetricReader getMetricReader();
+
+  @Nullable
+  abstract CardinalityLimitSelector getCardinalityLimitsSelector();
+}

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

@@ -15,6 +15,7 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.PullMetricExporterModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.PullMetricReaderModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.PushMetricExporterModel;
+import io.opentelemetry.sdk.metrics.export.CardinalityLimitSelector;
 import io.opentelemetry.sdk.metrics.export.MetricExporter;
 import io.opentelemetry.sdk.metrics.export.MetricReader;
 import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
@@ -23,7 +24,8 @@
 import java.time.Duration;
 import java.util.List;
 
-final class MetricReaderFactory implements Factory<MetricReaderModel, MetricReader> {
+final class MetricReaderFactory
+    implements Factory<MetricReaderModel, MetricReaderAndCardinalityLimits> {
 
   private static final MetricReaderFactory INSTANCE = new MetricReaderFactory();
 
@@ -34,7 +36,7 @@ static MetricReaderFactory getInstance() {
   }
 
   @Override
-  public MetricReader create(
+  public MetricReaderAndCardinalityLimits create(
       MetricReaderModel model, SpiHelper spiHelper, List<Closeable> closeables) {
     PeriodicMetricReaderModel periodicModel = model.getPeriodic();
     if (periodicModel != null) {
@@ -47,7 +49,15 @@ public MetricReader create(
       if (periodicModel.getInterval() != null) {
         builder.setInterval(Duration.ofMillis(periodicModel.getInterval()));
       }
-      return FileConfigUtil.addAndReturn(closeables, builder.build());
+      CardinalityLimitSelector cardinalityLimitSelector = null;
+      if (periodicModel.getCardinalityLimits() != null) {
+        cardinalityLimitSelector =
+            CardinalityLimitsFactory.getInstance()
+                .create(periodicModel.getCardinalityLimits(), spiHelper, closeables);
+      }
+      MetricReaderAndCardinalityLimits readerAndCardinalityLimits =
+          MetricReaderAndCardinalityLimits.create(builder.build(), cardinalityLimitSelector);
+      return FileConfigUtil.addAndReturn(closeables, readerAndCardinalityLimits);
     }
 
     PullMetricReaderModel pullModel = model.getPull();
@@ -59,7 +69,15 @@ public MetricReader create(
         MetricReader metricReader =
             FileConfigUtil.loadComponent(
                 spiHelper, MetricReader.class, "prometheus", prometheusModel);
-        return FileConfigUtil.addAndReturn(closeables, metricReader);
+        CardinalityLimitSelector cardinalityLimitSelector = null;
+        if (pullModel.getCardinalityLimits() != null) {
+          cardinalityLimitSelector =
+              CardinalityLimitsFactory.getInstance()
+                  .create(pullModel.getCardinalityLimits(), spiHelper, closeables);
+        }
+        MetricReaderAndCardinalityLimits readerAndCardinalityLimits =
+            MetricReaderAndCardinalityLimits.create(metricReader, cardinalityLimitSelector);
+        return FileConfigUtil.addAndReturn(closeables, readerAndCardinalityLimits);
       }
 
       throw new ConfigurationException("prometheus is the only currently supported pull reader");

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

@@ -43,6 +43,9 @@ public View create(ViewStreamModel model, SpiHelper spiHelper, List<Closeable> c
       builder.setAggregation(
           AggregationFactory.getInstance().create(model.getAggregation(), spiHelper, closeables));
     }
+    if (model.getAggregationCardinalityLimit() != null) {
+      builder.setCardinalityLimit(model.getAggregationCardinalityLimit());
+    }
     return builder.build();
   }
 

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/MetricReaderFactoryTest.java

@@ -76,7 +76,8 @@ void create_PeriodicDefaults() {
                                 new PushMetricExporterModel()
                                     .withOtlpHttp(new OtlpHttpMetricExporterModel()))),
                 spiHelper,
-                closeables);
+                closeables)
+            .getMetricReader();
     cleanup.addCloseable(reader);
     cleanup.addCloseables(closeables);
 
@@ -104,7 +105,8 @@ void create_PeriodicConfigured() {
                                     .withOtlpHttp(new OtlpHttpMetricExporterModel()))
                             .withInterval(1)),
                 spiHelper,
-                closeables);
+                closeables)
+            .getMetricReader();
     cleanup.addCloseable(reader);
     cleanup.addCloseables(closeables);
 
@@ -131,7 +133,8 @@ void create_PullPrometheusDefault() throws IOException {
                                     .withPrometheus(
                                         new PrometheusMetricExporterModel().withPort(port)))),
                 spiHelper,
-                closeables);
+                closeables)
+            .getMetricReader();
     cleanup.addCloseable(reader);
     cleanup.addCloseables(closeables);
 
@@ -164,7 +167,8 @@ void create_PullPrometheusConfigured() throws IOException {
                                             .withHost("localhost")
                                             .withPort(port)))),
                 spiHelper,
-                closeables);
+                closeables)
+            .getMetricReader();
     cleanup.addCloseable(reader);
     cleanup.addCloseables(closeables);