Struct substrate_prometheus_endpoint::HistogramOpts

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

pub fn new<S1, S2>(name: S1, help: S2) -> HistogramOpts

where S1: Into<String>, S2: Into<String>,

Create a HistogramOpts with the name and help arguments.

pub fn namespace<S>(self, namespace: S) -> HistogramOpts

where S: Into<String>,

namespace sets the namespace.

pub fn subsystem<S>(self, subsystem: S) -> HistogramOpts

where S: Into<String>,

subsystem sets the sub system.

pub fn const_labels( self, const_labels: HashMap<String, String>, ) -> HistogramOpts

const_labels sets the const labels.

pub fn const_label<S1, S2>(self, name: S1, value: S2) -> HistogramOpts

where S1: Into<String>, S2: Into<String>,

const_label adds a const label.

pub fn variable_labels(self, variable_labels: Vec<String>) -> HistogramOpts

variable_labels sets the variable labels.

pub fn variable_label<S>(self, name: S) -> HistogramOpts

where S: Into<String>,

variable_label adds a variable label.

pub fn fq_name(&self) -> String

fq_name returns the fq_name.

pub fn buckets(self, buckets: Vec<f64>) -> HistogramOpts

buckets set the buckets.

Trait Implementations

impl Clone for HistogramOpts

fn clone(&self) -> HistogramOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HistogramOpts

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

Formats the value using the given formatter.

impl Describer for HistogramOpts

fn describe(&self) -> Result<Desc, Error>

describe returns a [Desc].

impl From<Opts> for HistogramOpts

fn from(opts: Opts) -> HistogramOpts

Converts to this type from the input type.