Struct prometrics::metrics::SummaryBuilder

pub struct SummaryBuilder { /* fields omitted */ }

Summary builder.

Methods

impl SummaryBuilder

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

Makes a builder for summary named name.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets the namespace part of the metric name of this.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets the subsystem part of the metric name of this.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets the help of this.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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 "quantile" is reserved for designating summary quantiles.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Adds the default registry.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Adds a quantile.

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

Builds a summary.

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 quantile whose value is less than 0.0 or greater than 1.0

Trait Implementations

impl Debug for SummaryBuilder

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

Formats the value using the given formatter.