Struct prometheus::core::Desc

pub struct Desc {
    pub fq_name: String,
    pub help: String,
    pub const_label_pairs: Vec<LabelPair>,
    pub variable_labels: Vec<String>,
    pub id: u64,
    pub dim_hash: u64,
}

The descriptor used by every Prometheus Metric. It is essentially the immutable meta-data of a metric. The normal metric implementations included in this package manage their Desc under the hood.

Descriptors registered with the same registry have to fulfill certain consistency and uniqueness criteria if they share the same fully-qualified name: They must have the same help string and the same label names (aka label dimensions) in each, constLabels and variableLabels, but they must differ in the values of the constLabels.

Descriptors that share the same fully-qualified names and the same label values of their constLabels are considered equal.

Fields

fq_name: String

fq_name has been built from Namespace, Subsystem, and Name.

help: String

help provides some helpful information about this metric.

const_label_pairs: Vec<LabelPair>

const_label_pairs contains precalculated DTO label pairs based on the constant labels.

variable_labels: Vec<String>

variable_labels contains names of labels for which the metric maintains variable values.

id: u64

id is a hash of the values of the ConstLabels and fqName. This must be unique among all registered descriptors and can therefore be used as an identifier of the descriptor.

dim_hash: u64

dim_hash is a hash of the label names (preset and variable) and the Help string. Each Desc with the same fqName must have the same dimHash.

Implementations

impl Desc

pub fn new(
    fq_name: String,
    help: String,
    variable_labels: Vec<String>,
    const_labels: HashMap<String, String>
) -> Result<Desc>

Initializes a new Desc. Errors are recorded in the Desc and will be reported on registration time. variableLabels and constLabels can be nil if no such labels should be set. fqName and help must not be empty.

Trait Implementations

impl Clone for Desc

fn clone(&self) -> Desc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Desc

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

Formats the value using the given formatter.