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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use std::convert::From;
use std::sync::{Arc, RwLock};
use std::collections::HashMap;
use protobuf::RepeatedField;
use proto;
use desc::Desc;
use errors::{Result, Error};
use value::make_label_pairs;
use vec::{MetricVec, MetricVecBuilder};
use metrics::{Collector, Metric, Opts};
pub const DEFAULT_BUCKETS: &'static [f64; 11] = &[0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1.0,
2.5, 5.0, 10.0];
pub const BUCKET_LABEL: &'static str = "le";
#[inline]
fn check_bucket_lable(label: &str) -> Result<()> {
if label == BUCKET_LABEL {
return Err(Error::Msg("`le` is not allowed as label name in histograms".to_owned()));
}
Ok(())
}
pub fn check_and_adjust_buckets(mut buckets: Vec<f64>) -> Result<Vec<f64>> {
if buckets.is_empty() {
buckets = Vec::from(DEFAULT_BUCKETS as &'static [f64]);
}
for (i, upper_bound) in buckets.iter().enumerate() {
if i < (buckets.len() - 1) && *upper_bound >= buckets[i + 1] {
return Err(Error::Msg(format!("histogram buckets must be in increasing \
order: {} >= {}",
upper_bound,
buckets[i + 1])));
}
}
let tail = *buckets.last().unwrap();
if tail.is_sign_positive() && tail.is_infinite() {
buckets.pop();
}
Ok(buckets)
}
pub struct HistogramOpts {
pub common_opts: Opts,
pub buckets: Vec<f64>,
}
impl HistogramOpts {
pub fn new<S: Into<String>>(name: S, help: S) -> HistogramOpts {
HistogramOpts {
common_opts: Opts::new(name, help),
buckets: Vec::from(DEFAULT_BUCKETS as &'static [f64]),
}
}
pub fn namespace<S: Into<String>>(mut self, namesapce: S) -> Self {
self.common_opts.namespace = namesapce.into();
self
}
pub fn sub_system<S: Into<String>>(mut self, sub_system: S) -> Self {
self.common_opts.sub_system = sub_system.into();
self
}
pub fn const_labels(mut self, labels: HashMap<String, String>) -> Self {
self.common_opts = self.common_opts.const_labels(labels);
self
}
pub fn const_label<S: Into<String>>(mut self, name: S, value: S) -> Self {
self.common_opts = self.common_opts.const_label(name, value);
self
}
pub fn fq_name(&self) -> String {
self.common_opts.fq_name()
}
pub fn buckets(mut self, buckets: Vec<f64>) -> Self {
self.buckets = buckets;
self
}
}
impl From<Opts> for HistogramOpts {
fn from(opts: Opts) -> HistogramOpts {
HistogramOpts {
common_opts: opts,
buckets: Vec::from(DEFAULT_BUCKETS as &'static [f64]),
}
}
}
#[derive(Debug)]
struct HistogramCore {
sum: f64,
count: u64,
upper_bounds: Vec<f64>,
counts: Vec<u64>,
}
impl HistogramCore {
fn with_buckets(buckets: Vec<f64>) -> Result<HistogramCore> {
let buckets = try!(check_and_adjust_buckets(buckets));
Ok(HistogramCore {
sum: 0.0,
count: 0,
counts: vec![0; buckets.len()],
upper_bounds: buckets,
})
}
fn observe(&mut self, v: f64) {
let mut iter = self.upper_bounds.iter().enumerate().filter(|&(_, f)| v <= *f);
if let Some((i, _)) = iter.next() {
self.counts[i] += 1;
}
self.count += 1;
self.sum += v;
}
fn proto(&self) -> proto::Histogram {
let mut h = proto::Histogram::new();
h.set_sample_sum(self.sum);
h.set_sample_count(self.count);
let mut count = 0;
let mut buckets = Vec::with_capacity(self.upper_bounds.len());
for (i, upper_bound) in self.upper_bounds.iter().enumerate() {
count += self.counts[i];
let mut b = proto::Bucket::new();
b.set_cumulative_count(count);
b.set_upper_bound(*upper_bound);
buckets.push(b);
}
h.set_bucket(RepeatedField::from_vec(buckets));
h
}
}
impl Default for HistogramCore {
fn default() -> HistogramCore {
HistogramCore::with_buckets(vec![]).unwrap()
}
}
#[derive(Clone)]
pub struct Histogram {
desc: Desc,
label_pairs: Vec<proto::LabelPair>,
core: Arc<RwLock<HistogramCore>>,
}
impl Histogram {
pub fn with_opts(opts: HistogramOpts) -> Result<Histogram> {
let desc = try!(Desc::new(opts.fq_name(),
opts.common_opts.help.clone(),
vec![],
opts.common_opts.const_labels.clone()));
Histogram::with_desc(desc, &[])
}
fn with_desc(desc: Desc, label_values: &[&str]) -> Result<Histogram> {
for name in &desc.variable_labels {
try!(check_bucket_lable(&name));
}
for pair in &desc.const_label_pairs {
try!(check_bucket_lable(pair.get_name()));
}
let pairs = make_label_pairs(&desc, label_values);
let core = HistogramCore::default();
Ok(Histogram {
desc: desc,
label_pairs: pairs,
core: Arc::new(RwLock::new(core)),
})
}
}
impl Histogram {
pub fn observe(&self, v: f64) {
self.core.write().unwrap().observe(v)
}
}
impl Metric for Histogram {
fn metric(&self) -> proto::Metric {
let mut m = proto::Metric::new();
m.set_label(RepeatedField::from_vec(self.label_pairs.clone()));
let core = self.core.read().unwrap();
let h = core.proto();
m.set_histogram(h);
m
}
}
impl Collector for Histogram {
fn desc(&self) -> &Desc {
&self.desc
}
fn collect(&self) -> proto::MetricFamily {
let mut m = proto::MetricFamily::new();
m.set_name(self.desc.fq_name.clone());
m.set_help(self.desc.help.clone());
m.set_field_type(proto::MetricType::HISTOGRAM);
m.set_metric(RepeatedField::from_vec(vec![self.metric()]));
m
}
}
#[derive(Clone)]
pub struct HistogramVecBuilder {}
impl MetricVecBuilder for HistogramVecBuilder {
type Output = Histogram;
fn build(&self, desc: &Desc, vals: &[&str]) -> Result<Histogram> {
Histogram::with_desc(desc.clone(), vals)
}
}
pub type HistogramVec = MetricVec<HistogramVecBuilder>;
impl HistogramVec {
pub fn new(opts: HistogramOpts, label_names: &[&str]) -> Result<HistogramVec> {
let variable_names = label_names.iter().map(|s| (*s).to_owned()).collect();
let desc = try!(Desc::new(opts.fq_name(),
opts.common_opts.help,
variable_names,
opts.common_opts.const_labels));
let metric_vec =
MetricVec::create(desc, proto::MetricType::HISTOGRAM, HistogramVecBuilder {});
Ok(metric_vec as HistogramVec)
}
}
pub fn linear_buckets(start: f64, width: f64, count: usize) -> Result<Vec<f64>> {
if count < 1 {
return Err(Error::Msg(format!("LinearBuckets needs a positive count, count: {}", count)));
}
if width <= 0.0 {
return Err(Error::Msg(format!("LinearBuckets needs a width greater then 0, width: {}",
width)));
}
let mut next = start;
let mut buckets = Vec::with_capacity(count);
for _ in 0..count {
buckets.push(next);
next += width;
}
Ok(buckets)
}
pub fn exponential_buckets(start: f64, factor: f64, count: usize) -> Result<Vec<f64>> {
if count < 1 {
return Err(Error::Msg(format!("exponential_buckets needs a positive count, count: {}",
count)));
}
if start <= 0.0 {
return Err(Error::Msg(format!("exponential_buckets needs a positive start value, \
start: {}",
start)));
}
if factor <= 1.0 {
return Err(Error::Msg(format!("exponential_buckets needs a factor greater than 1, \
factor: {}",
factor)));
}
let mut next = start;
let mut buckets = Vec::with_capacity(count);
for _ in 0..count {
buckets.push(next);
next *= factor;
}
Ok(buckets)
}
#[cfg(test)]
mod tests {
use std::f64::{EPSILON, INFINITY};
use metrics::Collector;
use super::*;
#[test]
fn test_histogram() {
let opts = HistogramOpts::new("test", "test help")
.const_label("a", "1")
.const_label("b", "2");
let histogram = Histogram::with_opts(opts).unwrap();
histogram.observe(0.5);
histogram.observe(1.0);
let mf = histogram.collect();
let m = mf.get_metric().as_ref().get(0).unwrap();
assert_eq!(m.get_label().len(), 2);
let proto_histogram = m.get_histogram();
assert_eq!(proto_histogram.get_sample_count(), 2);
assert!((proto_histogram.get_sample_sum() - 1.5).abs() < EPSILON);
}
#[test]
fn test_buckets_invalidation() {
let table = vec![
(vec![], true, DEFAULT_BUCKETS.len()),
(vec![-2.0, -1.0, -0.5, 0.0, 0.5, 1.0, 2.0], true, 7),
(vec![-2.0, -1.0, -0.5, 10.0, 0.5, 1.0, 2.0], false, 7),
(vec![-2.0, -1.0, -0.5, 0.0, 0.5, 1.0, INFINITY], true, 6),
];
for (buckets, is_ok, length) in table {
let got = check_and_adjust_buckets(buckets);
assert_eq!(got.is_ok(), is_ok);
if is_ok {
assert_eq!(got.unwrap().len(), length);
}
}
}
#[test]
fn test_buckets_functions() {
let linear_table = vec![
(-15.0, 5.0, 6, true, vec![-15.0, -10.0, -5.0, 0.0, 5.0, 10.0]),
(-15.0, 0.0, 6, false, vec![]),
(-15.0, 5.0, 0, false, vec![]),
];
for (param1, param2, param3, is_ok, vec) in linear_table {
let got = linear_buckets(param1, param2, param3);
assert_eq!(got.is_ok(), is_ok);
if got.is_ok() {
assert_eq!(got.unwrap(), vec);
}
}
let exponential_table = vec![
(100.0, 1.2, 3, true, vec![100.0, 120.0, 144.0]),
(100.0, 0.5, 3, false, vec![]),
(100.0, 1.2, 0, false, vec![]),
];
for (param1, param2, param3, is_ok, vec) in exponential_table {
let got = exponential_buckets(param1, param2, param3);
assert_eq!(got.is_ok(), is_ok);
if got.is_ok() {
assert_eq!(got.unwrap(), vec);
}
}
}
}