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
use crate::core::Atomic;
use crate::counter::{CounterWithValueType, GenericLocalCounter};
use crate::histogram::{Instant, LocalHistogram};
use crate::metrics::MayFlush;
use crate::timer;
use parking_lot::Mutex;
use std::thread::LocalKey;

/// Delegator for auto flush-able local counter
pub trait CounterDelegator<T: 'static + MayFlush, V: CounterWithValueType> {
    /// Get the root local metric for delegate
    fn get_root_metric(&self) -> &'static LocalKey<T>;

    /// Get the final counter for delegate
    fn get_local<'a>(&self, root_metric: &'a T) -> &'a GenericLocalCounter<V::ValueType>;
}

/// Delegator for auto flush-able local counter
pub trait HistogramDelegator<T: 'static + MayFlush> {
    /// Get the root local metric for delegate
    fn get_root_metric(&self) -> &'static LocalKey<T>;

    /// Get the final counter for delegate
    fn get_local<'a>(&self, root_metric: &'a T) -> &'a LocalHistogram;
}

/// Auto flush-able local counter
#[derive(Debug)]
pub struct AFLocalCounter<T: 'static + MayFlush, V: CounterWithValueType, D: CounterDelegator<T, V>>
{
    /// Delegator to get thread local metric
    delegator: D,
    /// Phantomdata marker
    _p: std::marker::PhantomData<(Mutex<T>, Mutex<V>)>,
}

impl<T: 'static + MayFlush, V: CounterWithValueType, D: CounterDelegator<T, V>>
    AFLocalCounter<T, V, D>
{
    /// Construct a new AFLocalCounter from delegator.
    pub fn new(delegator: D) -> AFLocalCounter<T, V, D> {
        timer::ensure_updater();
        AFLocalCounter {
            delegator,
            _p: std::marker::PhantomData,
        }
    }
}

/// Auto flush-able local counter
impl<T: 'static + MayFlush, V: CounterWithValueType, D: CounterDelegator<T, V>>
    AFLocalCounter<T, V, D>
{
    #[inline]
    /// Get the root local metric for delegate
    fn get_root_metric(&self) -> &'static LocalKey<T> {
        self.delegator.get_root_metric()
    }

    #[inline]
    /// Get the final counter for delegate
    fn get_counter<'a>(&self, root_metric: &'a T) -> &'a GenericLocalCounter<V::ValueType> {
        self.delegator.get_local(root_metric)
    }

    /// Increase the given value to the local counter,
    /// and try to flush to global
    /// # Panics
    ///
    /// Panics in debug build if the value is < 0.
    #[inline]
    pub fn inc_by(&self, v: <V::ValueType as Atomic>::T) {
        self.get_root_metric().with(|m| {
            let counter = self.get_counter(m);
            counter.inc_by(v);
            m.may_flush();
        })
    }

    /// Increase the local counter by 1,
    /// and try to flush to global.
    #[inline]
    pub fn inc(&self) {
        self.get_root_metric().with(|m| {
            let counter = self.get_counter(m);
            counter.inc();
            m.may_flush();
        })
    }

    /// Return the local counter value.
    #[inline]
    pub fn get(&self) -> <V::ValueType as Atomic>::T {
        self.get_root_metric().with(|m| {
            let counter = self.get_counter(m);
            counter.get()
        })
    }

    /// Restart the counter, resetting its value back to 0.
    #[inline]
    pub fn reset(&self) {
        self.get_root_metric().with(|m| {
            let counter = self.get_counter(m);
            counter.reset();
        })
    }

    /// trigger flush of LocalKey<T>
    #[inline]
    pub fn flush(&self) {
        self.get_root_metric().with(|m| m.flush())
    }
}

/// Auto flush-able local counter
#[derive(Debug)]
pub struct AFLocalHistogram<T: 'static + MayFlush, D: HistogramDelegator<T>> {
    /// Delegator to get thread local metric
    delegator: D,
    /// Phantomdata marker
    _p: std::marker::PhantomData<Mutex<T>>,
}

impl<T: 'static + MayFlush, D: HistogramDelegator<T>> AFLocalHistogram<T, D> {
    /// Construct a new AFLocalHistogram from delegator
    pub fn new(delegator: D) -> AFLocalHistogram<T, D> {
        timer::ensure_updater();
        AFLocalHistogram {
            delegator,
            _p: std::marker::PhantomData,
        }
    }
}

impl<M: 'static + MayFlush, D: HistogramDelegator<M>> AFLocalHistogram<M, D> {
    /// Add a single observation to the [`Histogram`](::Histogram).
    pub fn observe(&self, v: f64) {
        self.delegator.get_root_metric().with(|m| {
            let local = self.delegator.get_local(m);
            local.observe(v);
            m.may_flush();
        })
    }

    /// Observe execution time of a closure, in second.
    pub fn observe_closure_duration<F, T>(&self, f: F) -> T
    where
        F: FnOnce() -> T,
    {
        let instant = Instant::now();
        let res = f();
        let elapsed = instant.elapsed_sec();
        self.observe(elapsed);
        res
    }

    /// Observe execution time of a closure, in second.
    #[cfg(feature = "nightly")]
    pub fn observe_closure_duration_coarse<F, T>(&self, f: F) -> T
    where
        F: FnOnce() -> T,
    {
        let instant = Instant::now_coarse();
        let res = f();
        let elapsed = instant.elapsed_sec();
        self.observe(elapsed);
        res
    }

    /// Clear the local metric.
    pub fn clear(&self) {
        self.delegator
            .get_root_metric()
            .with(|m| self.delegator.get_local(m).clear())
    }

    /// Flush the local metrics to the [`Histogram`](::Histogram) metric.
    pub fn flush(&self) {
        self.delegator
            .get_root_metric()
            .with(|m| self.delegator.get_local(m).flush());
    }

    /// Return accumulated sum of local samples.
    pub fn get_sample_sum(&self) -> f64 {
        self.delegator
            .get_root_metric()
            .with(|m| self.delegator.get_local(m).get_sample_sum())
    }

    /// Return count of local samples.
    pub fn get_sample_count(&self) -> u64 {
        self.delegator
            .get_root_metric()
            .with(|m| self.delegator.get_local(m).get_sample_count())
    }
}