metrics-util 0.20.3

Helper types/functions used by the metrics ecosystem.
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

use std::sync::Arc;

use metrics::{atomics::AtomicU64, CounterFn, GaugeFn, HistogramFn};

use crate::storage::AtomicBucket;

/// Defines the underlying storage for metrics as well as how to create them.
pub trait Storage<K> {
    /// The type used for counters.
    type Counter: CounterFn + Clone;

    /// The type used for gauges.
    type Gauge: GaugeFn + Clone;

    /// The type used for histograms.
    type Histogram: HistogramFn + Clone;

    /// Creates an empty counter.
    fn counter(&self, key: &K) -> Self::Counter;

    /// Creates an empty gauge.
    fn gauge(&self, key: &K) -> Self::Gauge;

    /// Creates an empty histogram.
    fn histogram(&self, key: &K) -> Self::Histogram;
}

impl<K, T: Storage<K>> Storage<K> for Arc<T> {
    type Counter = T::Counter;
    type Gauge = T::Gauge;
    type Histogram = T::Histogram;

    #[inline(always)]
    fn gauge(&self, key: &K) -> Self::Gauge {
        Storage::gauge(&**self, key)
    }
    #[inline(always)]
    fn counter(&self, key: &K) -> Self::Counter {
        Storage::counter(&**self, key)
    }
    #[inline(always)]
    fn histogram(&self, key: &K) -> Self::Histogram {
        Storage::histogram(&**self, key)
    }
}

/// Atomic metric storage.
///
/// Utilizes atomics for storing the value(s) of a given metric.  Shared access to the actual atomic
/// is handling via `Arc`.
#[derive(Debug)]
pub struct AtomicStorage;

impl<K> Storage<K> for AtomicStorage {
    type Counter = Arc<AtomicU64>;
    type Gauge = Arc<AtomicU64>;
    type Histogram = Arc<AtomicBucket<f64>>;

    fn counter(&self, _: &K) -> Self::Counter {
        Arc::new(AtomicU64::new(0))
    }

    fn gauge(&self, _: &K) -> Self::Gauge {
        Arc::new(AtomicU64::new(0))
    }

    fn histogram(&self, _: &K) -> Self::Histogram {
        Arc::new(AtomicBucket::new())
    }
}