Add cardinality limit demonstration (#520)

open-telemetry · Nov 14, 2024 · 0eba68f · 0eba68f
1 parent b1ceb4e
commit 0eba68f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/declarative-configuration/otel-sdk-config.yaml b/declarative-configuration/otel-sdk-config.yaml
@@ -1,7 +1,6 @@
 # See https://github.com/open-telemetry/opentelemetry-configuration for details on schema and examples
 
-# TODO: the current support file format is 0.3, but the opentelemetry-java errantly checks that it is 0.1. This will be fixed in 1.44.0.
-file_format: "0.1"
+file_format: "0.3"
 
 resource:
   attributes:

diff --git a/doc-snippets/configuration/src/main/java/otel/SdkMeterProviderConfig.java b/doc-snippets/configuration/src/main/java/otel/SdkMeterProviderConfig.java
@@ -15,11 +15,18 @@ public static SdkMeterProvider create(Resource resource) {
                 MetricReaderConfig.periodicMetricReader(
                     MetricExporterConfig.otlpHttpMetricExporter(
                         "http://localhost:4318/v1/metrics")));
+    // Uncomment to optionally register metric reader with cardinality limits
+    // builder.registerMetricReader(
+    //     MetricReaderConfig.periodicMetricReader(
+    //         MetricExporterConfig.otlpHttpMetricExporter("http://localhost:4318/v1/metrics")),
+    //     unusedInstrumentType -> 100);
+
     ViewConfig.dropMetricView(builder, "some.custom.metric");
     ViewConfig.histogramBucketBoundariesView(
         builder, "http.server.request.duration", List.of(1.0, 5.0, 10.0));
     ViewConfig.attributeFilterView(
         builder, "http.client.request.duration", Set.of("http.request.method"));
+    ViewConfig.cardinalityLimitsView(builder, "http.server.active_requests", 100);
     return builder.build();
   }
 }
diff --git a/doc-snippets/configuration/src/main/java/otel/ViewConfig.java b/doc-snippets/configuration/src/main/java/otel/ViewConfig.java
@@ -30,4 +30,11 @@ public static SdkMeterProviderBuilder attributeFilterView(
         InstrumentSelector.builder().setName(metricName).build(),
         View.builder().setAttributeFilter(keysToRetain).build());
   }
+
+  public static SdkMeterProviderBuilder cardinalityLimitsView(
+      SdkMeterProviderBuilder builder, String metricName, int cardinalityLimit) {
+    return builder.registerView(
+        InstrumentSelector.builder().setName(metricName).build(),
+        View.builder().setCardinalityLimit(cardinalityLimit).build());
+  }
 }
diff --git a/javaagent/sdk-config.yaml b/javaagent/sdk-config.yaml
@@ -13,8 +13,7 @@
 # vars defined in https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/.
 
 # The file format version.
-# TODO: the current support file format is 0.3, but the opentelemetry-java errantly checks that it is 0.1. This will be fixed in 1.44.0.
-file_format: "0.1"
+file_format: "0.3"
 
 # Configure if the SDK is disabled or not. This is not required to be provided to ensure the SDK isn't disabled, the default value when this is not provided is for the SDK to be enabled.
 disabled: false