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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
use std::collections::HashMap;
#[cfg(feature = "tokio-exporter")]
use std::future::Future;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
#[cfg(feature = "tokio-exporter")]
use std::thread;
use std::time::Duration;
#[cfg(feature = "tokio-exporter")]
use hyper::{
server::{conn::AddrStream, Server},
service::{make_service_fn, service_fn},
StatusCode, {Body, Error as HyperError, Response},
};
use metrics::Key;
use parking_lot::RwLock;
use quanta::Clock;
#[cfg(feature = "tokio-exporter")]
use tokio::{pin, runtime, select};
use metrics_util::{parse_quantiles, Handle, MetricKindMask, Quantile, Recency, Registry, Tracked};
#[cfg(feature = "tokio-exporter")]
use crate::common::InstallError;
use crate::common::Matcher;
use crate::distribution::DistributionBuilder;
use crate::recorder::{Inner, PrometheusRecorder};
use std::pin::Pin;
#[cfg(feature = "push-gateway")]
#[derive(Clone)]
pub struct PrometheusPushGatewayConfig {
address: String,
push_interval: std::time::Duration,
}
pub struct PrometheusBuilder {
listen_address: Option<SocketAddr>,
#[cfg(feature = "push-gateway")]
push_gateway_config: Option<PrometheusPushGatewayConfig>,
#[cfg(feature = "tokio-exporter")]
allow_ips: Option<Vec<ipnet::IpNet>>,
quantiles: Vec<Quantile>,
buckets: Option<Vec<f64>>,
bucket_overrides: Option<HashMap<Matcher, Vec<f64>>>,
idle_timeout: Option<Duration>,
recency_mask: MetricKindMask,
global_labels: Option<HashMap<String, String>>,
}
impl PrometheusBuilder {
pub fn new() -> Self {
let quantiles = parse_quantiles(&[0.0, 0.5, 0.9, 0.95, 0.99, 0.999, 1.0]);
Self {
listen_address: Some(SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 9000)),
#[cfg(feature = "tokio-exporter")]
allow_ips: None,
quantiles,
buckets: None,
bucket_overrides: None,
idle_timeout: None,
recency_mask: MetricKindMask::NONE,
global_labels: None,
#[cfg(feature = "push-gateway")]
push_gateway_config: None,
}
}
pub fn listen_address(mut self, addr: impl Into<SocketAddr>) -> Self {
self.listen_address = Some(addr.into());
self
}
pub fn disable_http_listener(mut self) -> Self {
self.listen_address = None;
self
}
#[cfg(feature = "push-gateway")]
pub fn push_gateway_config<T>(mut self, addr: T, interval: std::time::Duration) -> Self
where
T: AsRef<str>,
{
self.push_gateway_config = Some(PrometheusPushGatewayConfig {
address: addr.as_ref().to_string(),
push_interval: interval,
});
self
}
#[cfg(feature = "tokio-exporter")]
pub fn add_allowed(mut self, subnet: ipnet::IpNet) -> Self {
self.allow_ips.get_or_insert(vec![]).push(subnet);
self
}
pub fn set_quantiles(mut self, quantiles: &[f64]) -> Self {
self.quantiles = parse_quantiles(quantiles);
self
}
pub fn set_buckets(mut self, values: &[f64]) -> Self {
self.buckets = Some(values.to_vec());
self
}
pub fn set_buckets_for_metric(mut self, matcher: Matcher, values: &[f64]) -> Self {
let buckets = self.bucket_overrides.get_or_insert_with(HashMap::new);
buckets.insert(matcher.sanitized(), values.to_vec());
self
}
pub fn idle_timeout(mut self, mask: MetricKindMask, timeout: Option<Duration>) -> Self {
self.idle_timeout = timeout;
self.recency_mask = if self.idle_timeout.is_none() {
MetricKindMask::NONE
} else {
mask
};
self
}
pub fn add_global_label<K, V>(mut self, key: K, value: V) -> Self
where
K: Into<String>,
V: Into<String>,
{
let labels = self.global_labels.get_or_insert_with(HashMap::new);
labels.insert(key.into(), value.into());
self
}
#[cfg(feature = "tokio-exporter")]
pub fn install(self) -> Result<(), InstallError> {
let runtime = runtime::Builder::new_current_thread()
.enable_all()
.build()?;
let (recorder, exporter) = {
let _g = runtime.enter();
self.build_with_exporter()?
};
metrics::set_boxed_recorder(Box::new(recorder))?;
thread::Builder::new()
.name("metrics-exporter-prometheus-http".to_string())
.spawn(move || {
runtime.block_on(async move {
pin!(exporter);
loop {
select! {
_ = &mut exporter => {}
}
}
});
})?;
Ok(())
}
pub fn build(self) -> PrometheusRecorder {
self.build_with_clock(Clock::new())
}
pub(crate) fn build_with_clock(self, clock: Clock) -> PrometheusRecorder {
let inner = Inner {
registry: Registry::<Key, Handle, Tracked<Handle>>::tracked(),
recency: Recency::new(clock, self.recency_mask, self.idle_timeout),
distributions: RwLock::new(HashMap::new()),
distribution_builder: DistributionBuilder::new(
self.quantiles,
self.buckets,
self.bucket_overrides,
),
descriptions: RwLock::new(HashMap::new()),
global_labels: self.global_labels.unwrap_or(HashMap::new()),
};
PrometheusRecorder::from(inner)
}
#[cfg(feature = "tokio-exporter")]
pub fn build_with_exporter(
mut self,
) -> Result<
(
PrometheusRecorder,
Pin<Box<dyn Future<Output = Result<(), HyperError>> + Send + 'static>>,
),
InstallError,
> {
let address = self.listen_address;
let allow_ips = self.allow_ips.take();
#[cfg(feature = "push-gateway")]
let push_gateway_config = self.push_gateway_config.clone();
let recorder = self.build();
let handle = recorder.handle();
if let Some(address) = &address {
let server = Server::try_bind(&address)?;
let exporter = async move {
let make_svc = make_service_fn(move |socket: &AddrStream| {
let remote_addr = socket.remote_addr().ip();
let allowed = allow_ips
.as_ref()
.map(|subnets| subnets.iter().any(|subnet| subnet.contains(&remote_addr)))
.unwrap_or(true);
let handle = handle.clone();
async move {
Ok::<_, HyperError>(service_fn(move |_| {
let handle = handle.clone();
async move {
if allowed {
let output = handle.render();
Ok::<_, HyperError>(Response::new(Body::from(output)))
} else {
Ok::<_, HyperError>(
Response::builder()
.status(StatusCode::FORBIDDEN)
.body(Body::empty())
.expect("static response is valid"),
)
}
}
}))
}
});
server.serve(make_svc).await
};
return Ok((recorder, Box::pin(exporter)));
}
#[cfg(feature = "push-gateway")]
if let Some(push_gateway_config) = &push_gateway_config {
let push_interval = push_gateway_config.push_interval;
let push_address = push_gateway_config.address.to_string();
let exporter = async move {
let client = reqwest::Client::default();
loop {
tokio::time::sleep(push_interval).await;
let output = handle.render();
let response = client.put(push_address.as_str()).body(output).send().await;
match response {
Ok(response) => {
if let Err(e) = response.error_for_status() {
tracing::error!(
"error status code for pushing metrics to push gateway: {:?}",
e
)
}
}
Err(e) => {
tracing::error!("error pushing metrics to push gateway: {:?}", e)
}
}
}
};
return Ok((recorder, Box::pin(exporter)));
}
unimplemented!("must specify at least one of listen_address or push_gateway_config");
}
}
impl Default for PrometheusBuilder {
fn default() -> Self {
PrometheusBuilder::new()
}
}
#[cfg(test)]
mod tests {
use std::time::Duration;
use quanta::Clock;
use metrics::{GaugeValue, Key, Label, Recorder};
use metrics_util::MetricKindMask;
use super::{Matcher, PrometheusBuilder};
#[test]
fn test_render() {
let recorder = PrometheusBuilder::new().build();
let key = Key::from_name("basic_counter");
recorder.increment_counter(&key, 42);
let handle = recorder.handle();
let rendered = handle.render();
let expected_counter = "# TYPE basic_counter counter\nbasic_counter 42\n\n";
assert_eq!(rendered, expected_counter);
let labels = vec![Label::new("wutang", "forever")];
let key = Key::from_parts("basic_gauge", labels);
recorder.update_gauge(&key, GaugeValue::Absolute(-3.14));
let rendered = handle.render();
let expected_gauge = format!(
"{}# TYPE basic_gauge gauge\nbasic_gauge{{wutang=\"forever\"}} -3.14\n\n",
expected_counter
);
assert_eq!(rendered, expected_gauge);
let key = Key::from_name("basic_histogram");
recorder.record_histogram(&key, 12.0);
let rendered = handle.render();
let histogram_data = concat!(
"# TYPE basic_histogram summary\n",
"basic_histogram{quantile=\"0\"} 12\n",
"basic_histogram{quantile=\"0.5\"} 12\n",
"basic_histogram{quantile=\"0.9\"} 12\n",
"basic_histogram{quantile=\"0.95\"} 12\n",
"basic_histogram{quantile=\"0.99\"} 12\n",
"basic_histogram{quantile=\"0.999\"} 12\n",
"basic_histogram{quantile=\"1\"} 12\n",
"basic_histogram_sum 12\n",
"basic_histogram_count 1\n",
"\n"
);
let expected_histogram = format!("{}{}", expected_gauge, histogram_data);
assert_eq!(rendered, expected_histogram);
}
#[test]
fn test_buckets() {
const DEFAULT_VALUES: [f64; 3] = [10.0, 100.0, 1000.0];
const PREFIX_VALUES: [f64; 3] = [15.0, 105.0, 1005.0];
const SUFFIX_VALUES: [f64; 3] = [20.0, 110.0, 1010.0];
const FULL_VALUES: [f64; 3] = [25.0, 115.0, 1015.0];
let recorder = PrometheusBuilder::new()
.set_buckets_for_metric(
Matcher::Full("metrics.testing foo".to_owned()),
&FULL_VALUES[..],
)
.set_buckets_for_metric(
Matcher::Prefix("metrics.testing".to_owned()),
&PREFIX_VALUES[..],
)
.set_buckets_for_metric(Matcher::Suffix("foo".to_owned()), &SUFFIX_VALUES[..])
.set_buckets(&DEFAULT_VALUES[..])
.build();
let full_key = Key::from_name("metrics.testing_foo");
recorder.record_histogram(&full_key, FULL_VALUES[0]);
let prefix_key = Key::from_name("metrics.testing_bar");
recorder.record_histogram(&prefix_key, PREFIX_VALUES[1]);
let suffix_key = Key::from_name("metrics_testin_foo");
recorder.record_histogram(&suffix_key, SUFFIX_VALUES[2]);
let default_key = Key::from_name("metrics.wee");
recorder.record_histogram(&default_key, DEFAULT_VALUES[2] + 1.0);
let full_data = concat!(
"# TYPE metrics_testing_foo histogram\n",
"metrics_testing_foo_bucket{le=\"25\"} 1\n",
"metrics_testing_foo_bucket{le=\"115\"} 1\n",
"metrics_testing_foo_bucket{le=\"1015\"} 1\n",
"metrics_testing_foo_bucket{le=\"+Inf\"} 1\n",
"metrics_testing_foo_sum 25\n",
"metrics_testing_foo_count 1\n",
);
let prefix_data = concat!(
"# TYPE metrics_testing_bar histogram\n",
"metrics_testing_bar_bucket{le=\"15\"} 0\n",
"metrics_testing_bar_bucket{le=\"105\"} 1\n",
"metrics_testing_bar_bucket{le=\"1005\"} 1\n",
"metrics_testing_bar_bucket{le=\"+Inf\"} 1\n",
"metrics_testing_bar_sum 105\n",
"metrics_testing_bar_count 1\n",
);
let suffix_data = concat!(
"# TYPE metrics_testin_foo histogram\n",
"metrics_testin_foo_bucket{le=\"20\"} 0\n",
"metrics_testin_foo_bucket{le=\"110\"} 0\n",
"metrics_testin_foo_bucket{le=\"1010\"} 1\n",
"metrics_testin_foo_bucket{le=\"+Inf\"} 1\n",
"metrics_testin_foo_sum 1010\n",
"metrics_testin_foo_count 1\n",
);
let default_data = concat!(
"# TYPE metrics_wee histogram\n",
"metrics_wee_bucket{le=\"10\"} 0\n",
"metrics_wee_bucket{le=\"100\"} 0\n",
"metrics_wee_bucket{le=\"1000\"} 0\n",
"metrics_wee_bucket{le=\"+Inf\"} 1\n",
"metrics_wee_sum 1001\n",
"metrics_wee_count 1\n",
);
let handle = recorder.handle();
let rendered = handle.render();
assert!(rendered.contains(full_data));
assert!(rendered.contains(prefix_data));
assert!(rendered.contains(suffix_data));
assert!(rendered.contains(default_data));
}
#[test]
fn test_idle_timeout() {
let (clock, mock) = Clock::mock();
let recorder = PrometheusBuilder::new()
.idle_timeout(MetricKindMask::COUNTER, Some(Duration::from_secs(10)))
.build_with_clock(clock);
let key = Key::from_name("basic_counter");
recorder.increment_counter(&key, 42);
let key = Key::from_name("basic_gauge");
recorder.update_gauge(&key, GaugeValue::Absolute(-3.14));
let handle = recorder.handle();
let rendered = handle.render();
let expected = concat!(
"# TYPE basic_counter counter\n",
"basic_counter 42\n\n",
"# TYPE basic_gauge gauge\n",
"basic_gauge -3.14\n\n",
);
assert_eq!(rendered, expected);
mock.increment(Duration::from_secs(9));
let rendered = handle.render();
assert_eq!(rendered, expected);
mock.increment(Duration::from_secs(2));
let rendered = handle.render();
let expected = "# TYPE basic_gauge gauge\nbasic_gauge -3.14\n\n";
assert_eq!(rendered, expected);
}
#[test]
pub fn test_global_labels() {
let recorder = PrometheusBuilder::new()
.add_global_label("foo", "foo")
.add_global_label("foo", "bar")
.build();
let key = Key::from_name("basic_counter");
recorder.increment_counter(&key, 42);
let handle = recorder.handle();
let rendered = handle.render();
let expected_counter = "# TYPE basic_counter counter\nbasic_counter{foo=\"bar\"} 42\n\n";
assert_eq!(rendered, expected_counter);
}
#[test]
pub fn test_global_labels_overrides() {
let recorder = PrometheusBuilder::new()
.add_global_label("foo", "foo")
.build();
let key =
Key::from_name("overridden").with_extra_labels(vec![Label::new("foo", "overridden")]);
recorder.increment_counter(&key, 1);
let handle = recorder.handle();
let rendered = handle.render();
let expected_counter = "# TYPE overridden counter\noverridden{foo=\"overridden\"} 1\n\n";
assert_eq!(rendered, expected_counter);
}
}