Struct prometheus::HistogramOpts[][src]

pub struct HistogramOpts {
    pub common_opts: Opts,
    pub buckets: Vec<f64>,
}

A struct that bundles the options for creating a Histogram metric. It is mandatory to set Name and Help to a non-empty string. All other fields are optional and can safely be left at their zero value.

Fields

common_opts: Opts

A container holding various options.

buckets: Vec<f64>

Defines the buckets into which observations are counted. Each element in the slice is the upper inclusive bound of a bucket. The values must be sorted in strictly increasing order. There is no need to add a highest bucket with +Inf bound, it will be added implicitly. The default value is DefBuckets.

Implementations

impl HistogramOpts[src]

pub fn new<S1: Into<String>, S2: Into<String>>(
    name: S1,
    help: S2
) -> HistogramOpts
[src]

Create a HistogramOpts with the name and help arguments.

pub fn namespace<S: Into<String>>(self, namesapce: S) -> Self[src]

namespace sets the namespace.

pub fn subsystem<S: Into<String>>(self, subsystem: S) -> Self[src]

subsystem sets the sub system.

pub fn const_labels(self, const_labels: HashMap<String, String>) -> Self[src]

const_labels sets the const labels.

pub fn const_label<S1: Into<String>, S2: Into<String>>(
    self,
    name: S1,
    value: S2
) -> Self
[src]

const_label adds a const label.

pub fn variable_labels(self, variable_labels: Vec<String>) -> Self[src]

variable_labels sets the variable labels.

pub fn variable_label<S: Into<String>>(self, name: S) -> Self[src]

variable_label adds a variable label.

pub fn fq_name(&self) -> String[src]

fq_name returns the fq_name.

pub fn buckets(self, buckets: Vec<f64>) -> Self[src]

buckets set the buckets.

Trait Implementations

impl Clone for HistogramOpts[src]

impl Debug for HistogramOpts[src]

impl Describer for HistogramOpts[src]

impl From<Opts> for HistogramOpts[src]

Auto Trait Implementations

impl RefUnwindSafe for HistogramOpts

impl Send for HistogramOpts

impl Sync for HistogramOpts

impl Unpin for HistogramOpts

impl UnwindSafe for HistogramOpts

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.