fix: remove cardinality capping via instrument advice (#2995)

cijothomas · web-flow · commit 4be1a32d3fec · 2025-05-22T13:46:27.000-07:00
diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md
@@ -21,9 +21,7 @@ also modified to suppress telemetry before invoking exporters.
   - The default cardinality limit is 2000 and can be customized using Views.  
   - This feature was previously removed in version 0.28 due to the lack of
     configurability but has now been reintroduced with the ability to configure
-    the limit.  
-  - There is ability to configure cardinality limits via Instrument
-    advisory. [#2903](https://github.com/open-telemetry/opentelemetry-rust/pull/2903)
+    the limit.
   - Fixed the overflow attribute to correctly use the boolean value `true`
     instead of the string `"true"`.
     [#2878](https://github.com/open-telemetry/opentelemetry-rust/issues/2878)
diff --git a/opentelemetry-sdk/src/metrics/meter.rs b/opentelemetry-sdk/src/metrics/meter.rs
@@ -96,7 +96,6 @@ impl SdkMeter {
                 builder.description,
                 builder.unit,
                 None,
-                builder.cardinality_limit,
             )
             .map(|i| Counter::new(Arc::new(i)))
         {
@@ -139,7 +138,6 @@ impl SdkMeter {
             builder.description,
             builder.unit,
             None,
-            builder.cardinality_limit,
         ) {
             Ok(ms) => {
                 if ms.is_empty() {
@@ -199,7 +197,6 @@ impl SdkMeter {
             builder.description,
             builder.unit,
             None,
-            builder.cardinality_limit,
         ) {
             Ok(ms) => {
                 if ms.is_empty() {
@@ -259,7 +256,6 @@ impl SdkMeter {
             builder.description,
             builder.unit,
             None,
-            builder.cardinality_limit,
         ) {
             Ok(ms) => {
                 if ms.is_empty() {
@@ -321,7 +317,6 @@ impl SdkMeter {
                 builder.description,
                 builder.unit,
                 None,
-                builder.cardinality_limit,
             )
             .map(|i| UpDownCounter::new(Arc::new(i)))
         {
@@ -366,7 +361,6 @@ impl SdkMeter {
                 builder.description,
                 builder.unit,
                 None,
-                builder.cardinality_limit,
             )
             .map(|i| Gauge::new(Arc::new(i)))
         {
@@ -428,7 +422,6 @@ impl SdkMeter {
                 builder.description,
                 builder.unit,
                 builder.boundaries,
-                builder.cardinality_limit,
             )
             .map(|i| Histogram::new(Arc::new(i)))
         {
@@ -661,10 +654,8 @@ where
         description: Option<Cow<'static, str>>,
         unit: Option<Cow<'static, str>>,
         boundaries: Option<Vec<f64>>,
-        cardinality_limit: Option<usize>,
     ) -> MetricResult<ResolvedMeasures<T>> {
-        let aggregators =
-            self.measures(kind, name, description, unit, boundaries, cardinality_limit)?;
+        let aggregators = self.measures(kind, name, description, unit, boundaries)?;
         Ok(ResolvedMeasures {
             measures: aggregators,
         })
@@ -677,7 +668,6 @@ where
         description: Option<Cow<'static, str>>,
         unit: Option<Cow<'static, str>>,
         boundaries: Option<Vec<f64>>,
-        cardinality_limit: Option<usize>,
     ) -> MetricResult<Vec<Arc<dyn internal::Measure<T>>>> {
         let inst = Instrument {
             name,
@@ -687,7 +677,7 @@ where
             scope: self.meter.scope.clone(),
         };
 
-        self.resolve.measures(inst, boundaries, cardinality_limit)
+        self.resolve.measures(inst, boundaries)
     }
 }
 
diff --git a/opentelemetry-sdk/src/metrics/mod.rs b/opentelemetry-sdk/src/metrics/mod.rs
@@ -369,14 +369,12 @@ mod tests {
     async fn counter_aggregation_overflow_delta() {
         counter_aggregation_overflow_helper(Temporality::Delta);
         counter_aggregation_overflow_helper_custom_limit(Temporality::Delta);
-        counter_aggregation_overflow_helper_custom_limit_via_advice(Temporality::Delta);
     }
 
     #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
     async fn counter_aggregation_overflow_cumulative() {
         counter_aggregation_overflow_helper(Temporality::Cumulative);
         counter_aggregation_overflow_helper_custom_limit(Temporality::Cumulative);
-        counter_aggregation_overflow_helper_custom_limit_via_advice(Temporality::Cumulative);
     }
 
     #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
@@ -2955,103 +2953,6 @@ mod tests {
         }
     }
 
-    fn counter_aggregation_overflow_helper_custom_limit_via_advice(temporality: Temporality) {
-        // Arrange
-        let cardinality_limit = 2300;
-        let mut test_context = TestContext::new(temporality);
-        let meter = test_context.meter();
-        let counter = meter
-            .u64_counter("my_counter")
-            .with_cardinality_limit(cardinality_limit)
-            .build();
-
-        // Act
-        // Record measurements with A:0, A:1,.......A:cardinality_limit, which just fits in the cardinality_limit
-        for v in 0..cardinality_limit {
-            counter.add(100, &[KeyValue::new("A", v.to_string())]);
-        }
-
-        // Empty attributes is specially treated and does not count towards the limit.
-        counter.add(3, &[]);
-        counter.add(3, &[]);
-
-        // All of the below will now go into overflow.
-        counter.add(100, &[KeyValue::new("A", "foo")]);
-        counter.add(100, &[KeyValue::new("A", "another")]);
-        counter.add(100, &[KeyValue::new("A", "yet_another")]);
-        test_context.flush_metrics();
-
-        let MetricData::Sum(sum) = test_context.get_aggregation::<u64>("my_counter", None) else {
-            unreachable!()
-        };
-
-        // Expecting (cardinality_limit + 1 overflow + Empty attributes) data points.
-        assert_eq!(sum.data_points.len(), cardinality_limit + 1 + 1);
-
-        let data_point =
-            find_overflow_sum_datapoint(&sum.data_points).expect("overflow point expected");
-        assert_eq!(data_point.value, 300);
-
-        // let empty_attrs_data_point = &sum.data_points[0];
-        let empty_attrs_data_point = find_sum_datapoint_with_no_attributes(&sum.data_points)
-            .expect("Empty attributes point expected");
-        assert!(
-            empty_attrs_data_point.attributes.is_empty(),
-            "Non-empty attribute set"
-        );
-        assert_eq!(
-            empty_attrs_data_point.value, 6,
-            "Empty attributes value should be 3+3=6"
-        );
-
-        // Phase 2 - for delta temporality, after each collect, data points are cleared
-        // but for cumulative, they are not cleared.
-        test_context.reset_metrics();
-        // The following should be aggregated normally for Delta,
-        // and should go into overflow for Cumulative.
-        counter.add(100, &[KeyValue::new("A", "foo")]);
-        counter.add(100, &[KeyValue::new("A", "another")]);
-        counter.add(100, &[KeyValue::new("A", "yet_another")]);
-        test_context.flush_metrics();
-
-        let MetricData::Sum(sum) = test_context.get_aggregation::<u64>("my_counter", None) else {
-            unreachable!()
-        };
-
-        if temporality == Temporality::Delta {
-            assert_eq!(sum.data_points.len(), 3);
-
-            let data_point = find_sum_datapoint_with_key_value(&sum.data_points, "A", "foo")
-                .expect("point expected");
-            assert_eq!(data_point.value, 100);
-
-            let data_point = find_sum_datapoint_with_key_value(&sum.data_points, "A", "another")
-                .expect("point expected");
-            assert_eq!(data_point.value, 100);
-
-            let data_point =
-                find_sum_datapoint_with_key_value(&sum.data_points, "A", "yet_another")
-                    .expect("point expected");
-            assert_eq!(data_point.value, 100);
-        } else {
-            // For cumulative, overflow should still be there, and new points should not be added.
-            assert_eq!(sum.data_points.len(), cardinality_limit + 1 + 1);
-            let data_point =
-                find_overflow_sum_datapoint(&sum.data_points).expect("overflow point expected");
-            assert_eq!(data_point.value, 600);
-
-            let data_point = find_sum_datapoint_with_key_value(&sum.data_points, "A", "foo");
-            assert!(data_point.is_none(), "point should not be present");
-
-            let data_point = find_sum_datapoint_with_key_value(&sum.data_points, "A", "another");
-            assert!(data_point.is_none(), "point should not be present");
-
-            let data_point =
-                find_sum_datapoint_with_key_value(&sum.data_points, "A", "yet_another");
-            assert!(data_point.is_none(), "point should not be present");
-        }
-    }
-
     fn counter_aggregation_attribute_order_helper(temporality: Temporality, start_sorted: bool) {
         // Arrange
         let mut test_context = TestContext::new(temporality);
diff --git a/opentelemetry-sdk/src/metrics/pipeline.rs b/opentelemetry-sdk/src/metrics/pipeline.rs
@@ -254,7 +254,6 @@ where
         &self,
         inst: Instrument,
         boundaries: Option<&[f64]>,
-        cardinality_limit: Option<usize>,
     ) -> MetricResult<Vec<Arc<dyn internal::Measure<T>>>> {
         let mut matched = false;
         let mut measures = vec![];
@@ -312,7 +311,7 @@ where
             unit: Some(inst.unit),
             aggregation: None,
             allowed_attribute_keys: None,
-            cardinality_limit,
+            cardinality_limit: None,
         };
 
         // Override default histogram boundaries if provided.
@@ -737,12 +736,11 @@ where
         &self,
         id: Instrument,
         boundaries: Option<Vec<f64>>,
-        cardinality_limit: Option<usize>,
     ) -> MetricResult<Vec<Arc<dyn internal::Measure<T>>>> {
         let (mut measures, mut errs) = (vec![], vec![]);
 
         for inserter in &self.inserters {
-            match inserter.instrument(id.clone(), boundaries.as_deref(), cardinality_limit) {
+            match inserter.instrument(id.clone(), boundaries.as_deref()) {
                 Ok(ms) => measures.extend(ms),
                 Err(err) => errs.push(err),
             }
diff --git a/opentelemetry/CHANGELOG.md b/opentelemetry/CHANGELOG.md
@@ -24,8 +24,6 @@ disable telemetry generation during their internal operations, ensuring more
 predictable and efficient observability pipelines.
 
 - re-export `tracing` for `internal-logs` feature to remove the need of adding `tracing` as a dependency
-- Added ability to configure cardinality limits via Instrument
-  advisory. [#2903](https://github.com/open-telemetry/opentelemetry-rust/pull/2903)
 
 ## 0.29.1
 
diff --git a/opentelemetry/src/metrics/instruments/mod.rs b/opentelemetry/src/metrics/instruments/mod.rs
@@ -45,9 +45,6 @@ pub struct HistogramBuilder<'a, T> {
     /// Unit of the Histogram.
     pub unit: Option<Cow<'static, str>>,
 
-    /// Cardinality limit for the Histogram.
-    pub cardinality_limit: Option<usize>,
-
     /// Bucket boundaries for the histogram.
     pub boundaries: Option<Vec<f64>>,
 
@@ -63,7 +60,6 @@ impl<'a, T> HistogramBuilder<'a, T> {
             name,
             description: None,
             unit: None,
-            cardinality_limit: None,
             boundaries: None,
             _marker: marker::PhantomData,
         }
@@ -87,14 +83,6 @@ impl<'a, T> HistogramBuilder<'a, T> {
         self
     }
 
-    /// Set the cardinality limit for this Histogram.
-    /// Setting cardinality limit is optional. By default, the limit will be set
-    /// to 2000.
-    pub fn with_cardinality_limit(mut self, limit: usize) -> Self {
-        self.cardinality_limit = Some(limit);
-        self
-    }
-
     /// Set the boundaries for this histogram.
     ///
     /// Setting boundaries is optional. By default, the boundaries are set to:
@@ -162,9 +150,6 @@ pub struct InstrumentBuilder<'a, T> {
     /// Unit of the instrument.
     pub unit: Option<Cow<'static, str>>,
 
-    /// Cardinality limit for the instrument.
-    pub cardinality_limit: Option<usize>,
-
     _marker: marker::PhantomData<T>,
 }
 
@@ -176,7 +161,6 @@ impl<'a, T> InstrumentBuilder<'a, T> {
             name,
             description: None,
             unit: None,
-            cardinality_limit: None,
             _marker: marker::PhantomData,
         }
     }
@@ -198,14 +182,6 @@ impl<'a, T> InstrumentBuilder<'a, T> {
         self.unit = Some(unit.into());
         self
     }
-
-    /// Set the cardinality limit for this instrument.
-    /// Setting cardinality limit is optional. By default, the limit will be set
-    /// to 2000.
-    pub fn with_cardinality_limit(mut self, limit: usize) -> Self {
-        self.cardinality_limit = Some(limit);
-        self
-    }
 }
 
 macro_rules! build_instrument {
@@ -235,7 +211,6 @@ impl<T> fmt::Debug for InstrumentBuilder<'_, T> {
             .field("name", &self.name)
             .field("description", &self.description)
             .field("unit", &self.unit)
-            .field("cardinality_limit", &self.cardinality_limit)
             .field("kind", &std::any::type_name::<T>())
             .finish()
     }
@@ -247,7 +222,6 @@ impl<T> fmt::Debug for HistogramBuilder<'_, T> {
             .field("name", &self.name)
             .field("description", &self.description)
             .field("unit", &self.unit)
-            .field("cardinality_limit", &self.cardinality_limit)
             .field("boundaries", &self.boundaries)
             .field(
                 "kind",
@@ -281,9 +255,6 @@ pub struct AsyncInstrumentBuilder<'a, I, M> {
     /// Unit of the instrument.
     pub unit: Option<Cow<'static, str>>,
 
-    /// Cardinality limit for the instrument.
-    pub cardinality_limit: Option<usize>,
-
     /// Callbacks to be called for this instrument.
     pub callbacks: Vec<Callback<M>>,
 
@@ -298,7 +269,6 @@ impl<'a, I, M> AsyncInstrumentBuilder<'a, I, M> {
             name,
             description: None,
             unit: None,
-            cardinality_limit: None,
             _inst: marker::PhantomData,
             callbacks: Vec::new(),
         }
@@ -322,14 +292,6 @@ impl<'a, I, M> AsyncInstrumentBuilder<'a, I, M> {
         self
     }
 
-    /// Set the cardinality limit for this async instrument.
-    /// Setting cardinality limit is optional. By default, the limit will be set
-    /// to 2000.
-    pub fn with_cardinality_limit(mut self, limit: usize) -> Self {
-        self.cardinality_limit = Some(limit);
-        self
-    }
-
     /// Set the callback to be called for this instrument.
     pub fn with_callback<F>(mut self, callback: F) -> Self
     where
@@ -378,7 +340,6 @@ where
             .field("name", &self.name)
             .field("description", &self.description)
             .field("unit", &self.unit)
-            .field("cardinality_limit", &self.cardinality_limit)
             .field("kind", &std::any::type_name::<I>())
             .field("callbacks_len", &self.callbacks.len())
             .finish()
