Struct AggregatedMetricsState 

pub struct AggregatedMetricsState { /* private fields */ }

Aggregated metrics state.

Implementations

impl AggregatedMetricsState

pub fn visit_metrics<F>(&self, visitor: F)

where F: FnMut(&Context, &AggregatedMetricValue),

Visits all metrics.

pub fn find_single_with_tags(&self, name: &str, tags: &[&str]) -> Option<f64>

Searches the state for a single metric with a matching name and tags.

The latest value for the metric is returned. Histograms are skipped.

If no metric is found with a matching name and tags, or if multiple metrics are found with a matching name and tags, None is returned. Tags are matched on a partial basis: a metric must at least have the tags provided, but may have additional tags as well.

pub fn get_aggregated_with_tags(&self, name: &str, tags: &[&str]) -> f64

Searches the state for all counter metrics with a matching name and returns their aggregated value.

This method allows rolling up counter metrics that share a common name. For example, a metric may be emitted with the same name, but N different values for a specific tag, potentially as a way to break down the metric by a certain facet. This method can allow re-aggregating the value of each different facet value into a single value.

If multiple metrics are found with a matching name, but they’re not all counter metrics, or if no metrics are found with a matching name, 0.0 is returned.