Struct prometheus_client::metrics::exemplar::HistogramWithExemplars

pub struct HistogramWithExemplars<S> { /* private fields */ }

Open Metrics Histogram to both measure distributions of discrete events. and track references to data outside of the metric set.

let histogram = HistogramWithExemplars::new(exponential_buckets(1.0, 2.0, 10));
histogram.observe(4.2, Some(vec![("user_id".to_string(), "42".to_string())]));

You can also use exemplars with families. Just wrap the exemplar in a Family.

#[derive(Clone, Hash, PartialEq, Eq, EncodeLabelSet, Debug, Default)]
pub struct ResultLabel {
    pub result: String,
}

#[derive(Clone, Hash, PartialEq, Eq, EncodeLabelSet, Debug, Default)]
pub struct TraceLabel {
    pub trace_id: String,
}

let latency: Family<ResultLabel, HistogramWithExemplars<TraceLabel>> =
    Family::new_with_constructor(|| {
        HistogramWithExemplars::new(exponential_buckets(1.0, 2.0, 10))
    });

latency
    .get_or_create(&ResultLabel {
        result: "success".to_owned(),
    })
    .observe(
        0.001345422,
        Some(TraceLabel {
            trace_id: "3a2f90c9f80b894f".to_owned(),
        }),
    );

Implementations

impl<S> HistogramWithExemplars<S>

pub fn new(buckets: impl Iterator<Item = f64>) -> Self

Create a new HistogramWithExemplars.

pub fn observe(&self, v: f64, label_set: Option<S>)

Observe the given value, optionally providing a label set and thus setting the Exemplar value.

Trait Implementations

impl<S> Clone for HistogramWithExemplars<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for HistogramWithExemplars<S>

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

Formats the value using the given formatter.

impl<S: EncodeLabelSet> EncodeMetric for HistogramWithExemplars<S>

fn encode(&self, encoder: MetricEncoder<'_>) -> Result<(), Error>

Encode the given instance in the OpenMetrics text encoding.

fn metric_type(&self) -> MetricType

The OpenMetrics metric type of the instance.

impl<S> TypedMetric for HistogramWithExemplars<S>

const TYPE: MetricType = MetricType::Histogram

The OpenMetrics metric type.