Struct prometrics::metrics::HistogramBuilder

pub struct HistogramBuilder { /* fields omitted */ }

Histogram builder.

Methods

impl HistogramBuilder

pub fn new(name: &str) -> Self

Makes a builder for histograms named name.

pub fn with_linear_buckets(
    name: &str,
    start: f64,
    width: f64,
    count: usize
) -> Self

Makes a builder with the specified linear buckets.

pub fn with_exponential_buckets(
    name: &str,
    start: f64,
    factor: f64,
    count: usize
) -> Self

Makes a builder with the specified exponential buckets.

pub fn namespace(&mut self, namespace: &str) -> &mut Self

Sets the namespace part of the metric name of this.

pub fn subsystem(&mut self, subsystem: &str) -> &mut Self

Sets the subsystem part of the metric name of this.

pub fn help(&mut self, help: &str) -> &mut Self

Sets the help of this.

pub fn label(&mut self, name: &str, value: &str) -> &mut Self

Adds a label.

Note that name will be validated in the invocation of the finish method.

The name "le" is reserved for designating buckets.

pub fn registry(&mut self, registry: Registry) -> &mut Self

Adds a registry to which the resulting histograms will be registered..

pub fn default_registry(&mut self) -> &mut Self

Adds the default registry.

pub fn bucket(&mut self, upper_bound: f64) -> &mut Self

Adds a bucket.

pub fn buckets<I: IntoIterator<Item = f64>>(
    &mut self,
    upper_bounds: I
) -> &mut Self

Adds a sequence of buckets.

pub fn finish(&self) -> Result<Histogram>

Builds a histogram.

Errors

This method will return Err(_) if one of the following conditions is satisfied:

• Any of the name of the metric or labels is malformed
• There is a bucket whose upper bound is NaN

Trait Implementations

impl Debug for HistogramBuilder

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

Formats the value using the given formatter.