prometrics 0.1.13

Client library for exposing prometheus metrics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use std::time::Duration;

use metrics::{CounterBuilder, GaugeBuilder, HistogramBuilder, SummaryBuilder};
use {default_registry, Registry};

/// Common builder for various metrics.
#[derive(Debug, Clone)]
pub struct MetricBuilder {
    namespace: Option<String>,
    subsystem: Option<String>,
    labels: Vec<(String, String)>,
    registries: Vec<Registry>,
}
impl MetricBuilder {
    /// Makes a builder with the default registry.
    pub fn new() -> Self {
        Self::with_registry(default_registry())
    }

    /// Makes a builder with the given registry.
    pub fn with_registry(registry: Registry) -> Self {
        MetricBuilder {
            namespace: None,
            subsystem: None,
            labels: Vec::new(),
            registries: vec![registry],
        }
    }

    /// Makes a builder without any registries.
    pub fn without_registry() -> Self {
        MetricBuilder {
            namespace: None,
            subsystem: None,
            labels: Vec::new(),
            registries: Vec::new(),
        }
    }

    /// Sets the namespace part of the metric name.
    pub fn namespace(&mut self, namespace: &str) -> &mut Self {
        self.namespace = Some(namespace.to_owned());
        self
    }

    /// Sets the subsystem part of the metric name of this.
    pub fn subsystem(&mut self, subsystem: &str) -> &mut Self {
        self.subsystem = Some(subsystem.to_owned());
        self
    }

    /// Adds a label.
    ///
    /// Note that `name` will be validated when creating the metrics.
    pub fn label(&mut self, name: &str, value: &str) -> &mut Self {
        self.labels.push((name.to_owned(), value.to_owned()));
        self
    }

    /// Adds a registry to which the resulting metrics will be registered.
    pub fn registry(&mut self, registry: Registry) -> &mut Self {
        self.registries.push(registry);
        self
    }

    /// Clears the current registries, then sets `registry` as the new one.
    pub fn set_registry(&mut self, registry: Registry) -> &mut Self {
        self.registries = vec![registry];
        self
    }

    /// Makes a `CounterBuilder` that inherited the setting of this builder.
    pub fn counter(&self, name: &str) -> CounterBuilder {
        let mut builder = CounterBuilder::new(name);
        if let Some(ref namespace) = self.namespace {
            builder.namespace(namespace);
        }
        if let Some(ref subsystem) = self.subsystem {
            builder.subsystem(subsystem);
        }
        for &(ref k, ref v) in &self.labels {
            builder.label(k, v);
        }
        for r in &self.registries {
            builder.registry(r.clone());
        }
        builder
    }

    /// Makes a `GaugeBuilder` that inherited the setting of this builder.
    pub fn gauge(&self, name: &str) -> GaugeBuilder {
        let mut builder = GaugeBuilder::new(name);
        if let Some(ref namespace) = self.namespace {
            builder.namespace(namespace);
        }
        if let Some(ref subsystem) = self.subsystem {
            builder.subsystem(subsystem);
        }
        for &(ref k, ref v) in &self.labels {
            builder.label(k, v);
        }
        for r in &self.registries {
            builder.registry(r.clone());
        }
        builder
    }

    /// Makes a `HistogramBuilder` that inherited the setting of this builder.
    pub fn histogram(&self, name: &str) -> HistogramBuilder {
        let mut builder = HistogramBuilder::new(name);
        if let Some(ref namespace) = self.namespace {
            builder.namespace(namespace);
        }
        if let Some(ref subsystem) = self.subsystem {
            builder.subsystem(subsystem);
        }
        for &(ref k, ref v) in &self.labels {
            builder.label(k, v);
        }
        for r in &self.registries {
            builder.registry(r.clone());
        }
        builder
    }

    /// Makes a `SummaryBuilder` that inherited the setting of this builder.
    pub fn summary(&self, name: &str, window: Duration) -> SummaryBuilder {
        let mut builder = SummaryBuilder::new(name, window);
        if let Some(ref namespace) = self.namespace {
            builder.namespace(namespace);
        }
        if let Some(ref subsystem) = self.subsystem {
            builder.subsystem(subsystem);
        }
        for &(ref k, ref v) in &self.labels {
            builder.label(k, v);
        }
        for r in &self.registries {
            builder.registry(r.clone());
        }
        builder
    }
}
impl Default for MetricBuilder {
    fn default() -> Self {
        Self::new()
    }
}