Struct prometheus::Opts

source ·
pub struct Opts {
    pub namespace: String,
    pub subsystem: String,
    pub name: String,
    pub help: String,
    pub const_labels: HashMap<String, String>,
    pub variable_labels: Vec<String>,
}
Expand description

A struct that bundles the options for creating most Metric types.

Fields§

§namespace: String

namespace, subsystem, and name are components of the fully-qualified name of the Metric (created by joining these components with “_”). Only Name is mandatory, the others merely help structuring the name. Note that the fully-qualified name of the metric must be a valid Prometheus metric name.

§subsystem: String

namespace, subsystem, and name are components of the fully-qualified name of the Metric (created by joining these components with “_”). Only Name is mandatory, the others merely help structuring the name. Note that the fully-qualified name of the metric must be a valid Prometheus metric name.

§name: String

namespace, subsystem, and name are components of the fully-qualified name of the Metric (created by joining these components with “_”). Only Name is mandatory, the others merely help structuring the name. Note that the fully-qualified name of the metric must be a valid Prometheus metric name.

§help: String

help provides information about this metric. Mandatory!

Metrics with the same fully-qualified name must have the same Help string.

§const_labels: HashMap<String, String>

const_labels are used to attach fixed labels to this metric. Metrics with the same fully-qualified name must have the same label names in their ConstLabels.

Note that in most cases, labels have a value that varies during the lifetime of a process. Those labels are usually managed with a metric vector collector (like CounterVec, GaugeVec). ConstLabels serve only special purposes. One is for the special case where the value of a label does not change during the lifetime of a process, e.g. if the revision of the running binary is put into a label. Another, more advanced purpose is if more than one Collector needs to collect Metrics with the same fully-qualified name. In that case, those Metrics must differ in the values of their ConstLabels. See the Collector examples.

If the value of a label never changes (not even between binaries), that label most likely should not be a label at all (but part of the metric name).

§variable_labels: Vec<String>

variable_labels contains names of labels for which the metric maintains variable values. Metrics with the same fully-qualified name must have the same label names in their variable_labels.

Note that variable_labels is used in MetricVec. To create a single metric must leave it empty.

Implementations§

source§

impl Opts

source

pub fn new<S1: Into<String>, S2: Into<String>>(name: S1, help: S2) -> Opts

new creates the Opts with the name and help arguments.

source

pub fn namespace<S: Into<String>>(self, namespace: S) -> Self

namespace sets the namespace.

source

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

subsystem sets the sub system.

source

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

const_labels sets the const labels.

source

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

const_label adds a const label.

source

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

variable_labels sets the variable labels.

source

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

variable_label adds a variable label.

source

pub fn fq_name(&self) -> String

fq_name returns the fq_name.

Trait Implementations§

source§

impl Clone for Opts

source§

fn clone(&self) -> Opts

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Opts

source§

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

Formats the value using the given formatter. Read more
source§

impl Describer for Opts

source§

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

describe returns a Desc.
source§

impl From<Opts> for HistogramOpts

source§

fn from(opts: Opts) -> HistogramOpts

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Opts

§

impl RefUnwindSafe for Opts

§

impl Send for Opts

§

impl Sync for Opts

§

impl Unpin for Opts

§

impl UnwindSafe for Opts

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.