Struct prometheus::HistogramOpts
source · [−]Expand description
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
sourceimpl HistogramOpts
impl HistogramOpts
sourcepub fn new<S1: Into<String>, S2: Into<String>>(
name: S1,
help: S2
) -> HistogramOpts
pub fn new<S1: Into<String>, S2: Into<String>>(
name: S1,
help: S2
) -> HistogramOpts
Create a HistogramOpts
with the name
and help
arguments.
sourcepub fn const_labels(self, const_labels: HashMap<String, String>) -> Self
pub fn const_labels(self, const_labels: HashMap<String, String>) -> Self
const_labels
sets the const labels.
sourcepub fn const_label<S1: Into<String>, S2: Into<String>>(
self,
name: S1,
value: S2
) -> Self
pub fn const_label<S1: Into<String>, S2: Into<String>>(
self,
name: S1,
value: S2
) -> Self
const_label
adds a const label.
sourcepub fn variable_labels(self, variable_labels: Vec<String>) -> Self
pub fn variable_labels(self, variable_labels: Vec<String>) -> Self
variable_labels
sets the variable labels.
sourcepub fn variable_label<S: Into<String>>(self, name: S) -> Self
pub fn variable_label<S: Into<String>>(self, name: S) -> Self
variable_label
adds a variable label.
Trait Implementations
sourceimpl Clone for HistogramOpts
impl Clone for HistogramOpts
sourcefn clone(&self) -> HistogramOpts
fn clone(&self) -> HistogramOpts
Returns a copy of the value. Read more
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for HistogramOpts
impl Debug for HistogramOpts
sourceimpl Describer for HistogramOpts
impl Describer for HistogramOpts
sourceimpl From<Opts> for HistogramOpts
impl From<Opts> for HistogramOpts
sourcefn from(opts: Opts) -> HistogramOpts
fn from(opts: Opts) -> HistogramOpts
Converts to this type from the input type.
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
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more