Struct prometheus::Opts
[−]
[src]
pub struct Opts {
pub namespace: String,
pub sub_system: String,
pub name: String,
pub help: String,
pub const_labels: HashMap<String, String>,
}Opts bundles the options for creating most Metric types.
Fields
namespace: String
namespace, sub_system, 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.
sub_system: String
name: String
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, UntypedVec). 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).
Methods
impl Opts[src]
fn new<S: Into<String>>(name: S, help: S) -> Opts
new creates the Opts with the name and help arguments.
fn namespace<S: Into<String>>(self, namesapce: S) -> Self
namespace sets the namespace.
fn sub_system<S: Into<String>>(self, sub_system: S) -> Self
sub_system sets the sub system.
fn const_labels(self, labels: HashMap<String, String>) -> Self
const_labels sets the const labels.
fn const_label<S: Into<String>>(self, name: S, value: S) -> Self
const_label adds a const label.
fn fq_name(&self) -> String
fq_name returns the fq_name.