Struct PrometheusMetrics

pub struct PrometheusMetrics {
    metrics: Registry,
    namespace: Vec<String>,
    children: Arc<RwLock<HashMap<String, PrometheusMetrics>>>,
    counters: Arc<RwLock<HashMap<String, Counter>>>,
    gauges: Arc<RwLock<HashMap<String, Gauge>>>,
    histograms: Arc<RwLock<HashMap<String, Histogram>>>,
    counter_families: Arc<RwLock<HashMap<String, CounterFamily>>>,
    gauge_families: Arc<RwLock<HashMap<String, GaugeFamily>>>,
    histogram_families: Arc<RwLock<HashMap<String, HistogramFamily>>>,
}

A Prometheus-based implementation of a Metrics registry.

PrometheusMetrics provides a collection of metrics including Counter, Gauge, and Histogram. These metrics can be created and associated with a PrometheusMetrics collection and then used as handles for updating and populating. The PrometheusMetrics registry can then be used to collect all of the associated metrics and export them in the Prometheus text format.

This implementation provides a few features beyond the basic [prometheus] features. It supports hierarchical namespaces; any PrometheusMetrics can be used to derive a subgroup with a certain name. The subgroup is then related to the parent, and any PrometheusMetrics in the tree of related groups can be used to collect all registered metrics. The namespacing will be reflected in the fully qualified name of each metric in the Prometheus output. The subgroup relationship is pure and deterministic – calling get_subgroup with the same subgroup name will always return a handle to the same underlying PrometheusMetrics object.

PrometheusMetrics also supports querying for individual metrics by name, unlike [prometheus::Registry]. This provides a programming interface for inspecting the values of specific metrics at run-time, if that is preferable to exporting all metrics wholesale.

Fields

metrics: Registry

namespace: Vec<String>

children: Arc<RwLock<HashMap<String, PrometheusMetrics>>>

counters: Arc<RwLock<HashMap<String, Counter>>>

gauges: Arc<RwLock<HashMap<String, Gauge>>>

histograms: Arc<RwLock<HashMap<String, Histogram>>>

counter_families: Arc<RwLock<HashMap<String, CounterFamily>>>

gauge_families: Arc<RwLock<HashMap<String, GaugeFamily>>>

histogram_families: Arc<RwLock<HashMap<String, HistogramFamily>>>

Implementations

impl PrometheusMetrics

pub fn get_counter(&self, name: &str) -> Result<Counter, MetricsError>

Get a counter in this sub-group by name.

pub fn get_gauge(&self, name: &str) -> Result<Gauge, MetricsError>

Get a gauge in this sub-group by name.

pub fn get_histogram(&self, name: &str) -> Result<Histogram, MetricsError>

Get a histogram in this sub-group by name.

pub fn get_counter_family( &self, name: &str, ) -> Result<CounterFamily, MetricsError>

Get a counter family in this sub-group by name.

pub fn gauge_family(&self, name: &str) -> Result<GaugeFamily, MetricsError>

Get a gauge family in this sub-group by name.

pub fn get_histogram_family( &self, name: &str, ) -> Result<HistogramFamily, MetricsError>

Get a histogram family in this sub-group by name.

pub fn get_subgroup<I>( &self, path: I, ) -> Result<PrometheusMetrics, MetricsError>

where I: IntoIterator, I::Item: AsRef<str>,

Get a (possibly nested) subgroup of this group by its path.

fn get_metric<M: Clone>( &self, metrics: &Arc<RwLock<HashMap<String, M>>>, name: &str, ) -> Result<M, MetricsError>

fn metric_opts(&self, name: String, unit_label: Option<String>) -> Opts

Trait Implementations

impl Clone for PrometheusMetrics

fn clone(&self) -> PrometheusMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrometheusMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PrometheusMetrics

fn default() -> PrometheusMetrics

Returns the “default value” for a type.

impl Metrics for PrometheusMetrics

type Error = MetricsError

fn export(&self) -> Result<String, Self::Error>

impl Metrics for PrometheusMetrics

fn create_counter( &self, name: String, unit_label: Option<String>, ) -> Box<dyn Counter>

Create a Counter with an optional unit_label.

fn create_gauge( &self, name: String, unit_label: Option<String>, ) -> Box<dyn Gauge>

Create a Gauge with an optional unit_label.

fn create_histogram( &self, name: String, unit_label: Option<String>, ) -> Box<dyn Histogram>

Create a Histogram with an optional unit_label.

fn create_text(&self, name: String)

Create a text metric.

fn counter_family( &self, name: String, labels: Vec<String>, ) -> Box<dyn CounterFamily>

Create a family of related counters, partitioned by their label values.

fn gauge_family( &self, name: String, labels: Vec<String>, ) -> Box<dyn GaugeFamily>

Create a family of related gauges, partitioned by their label values.

fn histogram_family( &self, name: String, labels: Vec<String>, ) -> Box<dyn HistogramFamily>

Create a family of related histograms, partitioned by their label values.

fn text_family(&self, name: String, labels: Vec<String>) -> Box<dyn TextFamily>

Create a family of related text metricx, partitioned by their label values.

fn subgroup(&self, subgroup_name: String) -> Box<dyn Metrics>

Create a subgroup with a specified prefix.