Struct AggregateCounter 

pub struct AggregateCounter { /* private fields */ }

A Prometheus CounterVec wrapper that automatically produces an extra unlabeled aggregate metric (the sum of all label combinations) in addition to the per-label counters.

This is useful when you want a single metric name to expose both a total and a per-dimension breakdown without maintaining a separate Counter.

Example

use prometheus::Opts;
use prometheus::core::Collector;
use prometheus_extensions::AggregateCounter;

let counter = AggregateCounter::new(
    Opts::new("rpc_calls_total", "Total RPC calls"),
    &["service"],
).unwrap();

counter.with_label_values(&["auth"]).inc_by(10.0);
counter.with_label_values(&["billing"]).inc_by(20.0);

let families = counter.collect();
let metrics = families[0].get_metric();

// First metric is the aggregate (no labels, value = 30)
assert_eq!(metrics[0].get_label().len(), 0);
assert_eq!(metrics[0].get_counter().value(), 30.0);

// Remaining metrics are the per-label counters
assert_eq!(metrics.len(), 3); // 1 aggregate + 2 labeled

Implementations

impl AggregateCounter

pub fn new(opts: Opts, label_names: &[&str]) -> Result<Self, Error>

Create a new AggregateCounter.

opts defines the metric name and help string. label_names are the label dimensions for the per-label counters.

pub fn with_label_values(&self, vals: &[&str]) -> Counter

Return a Counter for the given label values, creating it if it does not already exist.

Trait Implementations

impl Clone for AggregateCounter

fn clone(&self) -> AggregateCounter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Collector for AggregateCounter

fn desc(&self) -> Vec<&Desc>

Return descriptors for metrics.

fn collect(&self) -> Vec<MetricFamily>

Collect metrics.