Stable cardinality limit property otel.java.metrics.cardinality.limit (#7199)

Author: jack-berg

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

@@ -21,10 +21,13 @@
 import java.util.Locale;
 import java.util.Set;
 import java.util.function.BiFunction;
+import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 final class MeterProviderConfiguration {
 
+  private static final Logger logger = Logger.getLogger(MeterProviderConfiguration.class.getName());
+
   static void configureMeterProvider(
       SdkMeterProviderBuilder meterProviderBuilder,
       ConfigProperties config,
@@ -51,19 +54,26 @@ static void configureMeterProvider(
         break;
     }
 
-    int cardinalityLimit =
-        config.getInt(
-            "otel.experimental.metrics.cardinality.limit", MetricStorage.DEFAULT_MAX_CARDINALITY);
-    if (cardinalityLimit < 1) {
-      throw new ConfigurationException("otel.experimental.metrics.cardinality.limit must be >= 1");
+    Integer cardinalityLimit = config.getInt("otel.java.metrics.cardinality.limit");
+    if (cardinalityLimit == null) {
+      cardinalityLimit = config.getInt("otel.experimental.metrics.cardinality.limit");
+      if (cardinalityLimit != null) {
+        logger.warning(
+            "otel.experimental.metrics.cardinality.limit is deprecated and will be removed after 1.51.0 release. Please use otel.java.metrics.cardinality.limit instead.");
+      }
+    }
+    if (cardinalityLimit != null && cardinalityLimit < 1) {
+      throw new ConfigurationException("otel.java.metrics.cardinality.limit must be >= 1");
     }
+    int resolvedCardinalityLimit =
+        cardinalityLimit == null ? MetricStorage.DEFAULT_MAX_CARDINALITY : cardinalityLimit;
 
     configureMetricReaders(
             config, spiHelper, metricReaderCustomizer, metricExporterCustomizer, closeables)
         .forEach(
             reader ->
                 meterProviderBuilder.registerMetricReader(
-                    reader, instrumentType -> cardinalityLimit));
+                    reader, instrumentType -> resolvedCardinalityLimit));
   }
 
   static List<MetricReader> configureMetricReaders(

sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/MeterProviderConfigurationTest.java

@@ -46,15 +46,15 @@ void configureMeterProvider_InvalidCardinalityLimit() {
                       ImmutableMap.of(
                           "otel.metrics.exporter",
                           "logging",
-                          "otel.experimental.metrics.cardinality.limit",
+                          "otel.java.metrics.cardinality.limit",
                           "0")),
                   spiHelper,
                   (a, b) -> a,
                   (a, b) -> a,
                   closeables);
             })
         .isInstanceOf(ConfigurationException.class)
-        .hasMessage("otel.experimental.metrics.cardinality.limit must be >= 1");
+        .hasMessage("otel.java.metrics.cardinality.limit must be >= 1");
     cleanup.addCloseables(closeables);
   }
 
@@ -77,6 +77,26 @@ void configureMeterProvider_ConfiguresCardinalityLimit() {
 
     // Customized limit cardinality limit to 100
     builder = SdkMeterProvider.builder();
+    MeterProviderConfiguration.configureMeterProvider(
+        builder,
+        DefaultConfigProperties.createFromMap(
+            ImmutableMap.of(
+                "otel.metrics.exporter",
+                "logging",
+                "otel.java.metrics.cardinality.limit",
+                "100",
+                // otel.java.metrics.cardinality.limit takes priority over deprecated property
+                "otel.experimental.metrics.cardinality.limit",
+                "200")),
+        spiHelper,
+        (a, b) -> a,
+        (a, b) -> a,
+        closeables);
+    cleanup.addCloseables(closeables);
+    assertCardinalityLimit(builder, 100);
+
+    // Deprecated property
+    builder = SdkMeterProvider.builder();
     MeterProviderConfiguration.configureMeterProvider(
         builder,
         DefaultConfigProperties.createFromMap(