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
use crate::instruments::fundamentals::{buckets::SecondsBuckets, Clock};
use crate::snapshot::Snapshot;

#[derive(Default)]
pub struct Bucket {
    pub sum: i64,
    pub count: u64,
    pub min_max: (i64, i64),
}

impl Bucket {
    pub fn update(&mut self, v: i64) {
        self.min_max = if self.count != 0 {
            let (min, max) = self.min_max;
            (std::cmp::min(min, v), std::cmp::max(max, v))
        } else {
            (v, v)
        };
        self.sum += v;
        self.count += 1;
    }
}

#[derive(Debug, PartialEq)]
pub struct BucketsStats {
    peak: i64,
    peak_min: i64,
    peak_avg: f64,
    bottom: i64,
    bottom_max: i64,
    bottom_avg: f64,
    avg: f64,
}

impl BucketsStats {
    pub fn from_buckets<C: Clock>(
        buckets: &mut SecondsBuckets<Bucket, C>,
        current_value: Option<i64>, // we take an option to make this configurable later
    ) -> Option<Self> {
        let mut peak = std::i64::MIN;
        let mut peak_min = std::i64::MAX;
        let mut bottom = std::i64::MAX;
        let mut bottom_max = std::i64::MIN;
        let mut sum_bottom = 0;
        let mut sum_peak = 0;
        let mut total_sum = 0;
        let mut total_count = 0;

        buckets.iter().for_each(
            |Bucket {
                 sum,
                 count,
                 min_max,
             }| {
                if *count != 0 {
                    total_sum += sum;
                    total_count += count;

                    let (min, max) = min_max;

                    peak = std::cmp::max(peak, *max);
                    peak_min = std::cmp::min(peak_min, *max);
                    bottom = std::cmp::min(bottom, *min);
                    bottom_max = std::cmp::max(bottom_max, *min);
                    sum_bottom += min;
                    sum_peak += max;
                }
            },
        );

        if total_count != 0 {
            let avg = (total_sum as f64) / (total_count as f64);
            let bottom_avg = (sum_bottom as f64) / (buckets.len() as f64);
            let peak_avg = (sum_peak as f64) / (buckets.len() as f64);
            Some(BucketsStats {
                peak,
                peak_min,
                peak_avg,
                bottom,
                bottom_max,
                bottom_avg,
                avg,
            })
        } else {
            if let Some(current_value) = current_value {
                Some(BucketsStats {
                    peak: current_value,
                    peak_min: current_value,
                    peak_avg: current_value as f64,
                    bottom: current_value,
                    bottom_max: current_value,
                    bottom_avg: current_value as f64,
                    avg: current_value as f64,
                })
            } else {
                None
            }
        }
    }

    pub fn add_to_snapshot(self, snapshot: &mut Snapshot, prefix: Option<&str>) {
        use std::borrow::Cow;
        let prefix = if let Some(prefix) = prefix {
            Cow::Owned(format!("{}_", prefix))
        } else {
            Cow::Borrowed("")
        };
        let peak_name = format!("{}peak", prefix);
        snapshot.items.push((peak_name, self.peak.into()));
        let peak_min_name = format!("{}peak_min", prefix);
        snapshot.items.push((peak_min_name, self.peak_min.into()));
        let peak_avg_name = format!("{}peak_avg", prefix);
        snapshot.items.push((peak_avg_name, self.peak_avg.into()));
        let bottom_name = format!("{}bottom", prefix);
        snapshot.items.push((bottom_name, self.bottom.into()));
        let bottom_max_name = format!("{}bottom_max", prefix);
        snapshot
            .items
            .push((bottom_max_name, self.bottom_max.into()));
        let bottom_avg_name = format!("{}bottom_avg", prefix);
        snapshot
            .items
            .push((bottom_avg_name, self.bottom_avg.into()));
        let avg_name = format!("{}avg", prefix);
        snapshot.items.push((avg_name, self.avg.into()));
    }
}

#[cfg(test)]
#[allow(clippy::float_cmp)]
mod test {
    use crate::instruments::fundamentals::buckets::SecondsBuckets;
    use crate::instruments::fundamentals::ManualOffsetClock;

    use super::*;

    #[test]
    fn empty_bucket_returns_none() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(1, clock);

        assert!(BucketsStats::from_buckets(&mut buckets, None).is_none());
    }

    #[test]
    fn none_empty_bucket_returns_some() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(1, clock);
        buckets.current_mut().update(1);

        assert!(BucketsStats::from_buckets(&mut buckets, None).is_some());
    }

    #[test]
    fn one_bucket_works_correctly_with_one_update() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(1, clock);
        buckets.current_mut().update(1);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 1);
        assert_eq!(stats.peak_min, 1);
        assert_eq!(stats.peak_avg, 1.0);
        assert_eq!(stats.bottom, 1);
        assert_eq!(stats.bottom_max, 1);
        assert_eq!(stats.bottom_avg, 1.0);
        assert_eq!(stats.avg, 1.0);
    }

    #[test]
    fn one_bucket_works_correctly_with_two_different_updates_in_the_same_bucket() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(1, clock);
        buckets.current_mut().update(1);
        buckets.current_mut().update(2);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 2, "peak");
        assert_eq!(stats.peak_min, 2, "peak_min");
        assert_eq!(stats.peak_avg, 2.0, "peak_avg");
        assert_eq!(stats.bottom, 1, "bottom");
        assert_eq!(stats.bottom_max, 1, "bottom_max");
        assert_eq!(stats.bottom_avg, 1.0, "bottom_avg");
        assert_eq!(stats.avg, 1.5, "avg");
    }

    #[test]
    fn one_bucket_works_correctly_with_2_times_the_same_updates_and_one_bucket_shift() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(1, clock.clone());
        buckets.current_mut().update(1);
        clock.advance_a_second();
        buckets.current_mut().update(1);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 1, "peak");
        assert_eq!(stats.peak_min, 1, "peak_min");
        assert_eq!(stats.peak_avg, 1.0, "peak_avg");
        assert_eq!(stats.bottom, 1, "bottom");
        assert_eq!(stats.bottom_max, 1, "bottom_max");
        assert_eq!(stats.bottom_avg, 1.0, "bottom_avg");
        assert_eq!(stats.avg, 1.0, "avg");
    }

    #[test]
    fn one_bucket_works_correctly_with_2_times_a_different_update_and_one_bucket_shift() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(1, clock.clone());
        buckets.current_mut().update(1);
        clock.advance_a_second();
        buckets.current_mut().update(2);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 2, "peak");
        assert_eq!(stats.peak_min, 2, "peak_min");
        assert_eq!(stats.peak_avg, 2.0, "peak_avg");
        assert_eq!(stats.bottom, 2, "bottom");
        assert_eq!(stats.bottom_max, 2, "bottom_max");
        assert_eq!(stats.bottom_avg, 2.0, "bottom_avg");
        assert_eq!(stats.avg, 2.0, "avg");
    }

    #[test]
    fn two_buckets_works_correctly_with_2_times_the_same_updates_and_one_bucket_shift() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(2, clock.clone());
        buckets.current_mut().update(1);
        clock.advance_a_second();
        buckets.current_mut().update(1);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 1, "peak");
        assert_eq!(stats.peak_min, 1, "peak_min");
        assert_eq!(stats.peak_avg, 1.0, "peak_avg");
        assert_eq!(stats.bottom, 1, "bottom");
        assert_eq!(stats.bottom_max, 1, "bottom_max");
        assert_eq!(stats.bottom_avg, 1.0, "bottom_avg");
        assert_eq!(stats.avg, 1.0, "avg");
    }

    #[test]
    fn two_buckets_works_correctly_with_different_updates_and_one_bucket_shift() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(2, clock.clone());
        buckets.current_mut().update(1);
        clock.advance_a_second();
        buckets.current_mut().update(2);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 2, "peak");
        assert_eq!(stats.peak_min, 1, "peak_min");
        assert_eq!(stats.peak_avg, 1.5, "peak_avg");
        assert_eq!(stats.bottom, 1, "bottom");
        assert_eq!(stats.bottom_max, 2, "bottom_max");
        assert_eq!(stats.bottom_avg, 1.5, "bottom_avg");
        assert_eq!(stats.avg, 1.5, "avg");
    }

    #[test]
    fn two_buckets_works_correctly_2_different_updates_in_each_bucket_with_one_bucket_shift() {
        let clock = ManualOffsetClock::default();
        let mut buckets = SecondsBuckets::<Bucket, _>::with_clock(2, clock.clone());
        buckets.current_mut().update(2);
        buckets.current_mut().update(5);
        clock.advance_a_second();
        buckets.current_mut().update(4);
        buckets.current_mut().update(7);

        let stats = BucketsStats::from_buckets(&mut buckets, None).unwrap();
        assert_eq!(stats.peak, 7, "peak");
        assert_eq!(stats.peak_min, 5, "peak_min");
        assert_eq!(stats.peak_avg, 6.0, "peak_avg");
        assert_eq!(stats.bottom, 2, "bottom");
        assert_eq!(stats.bottom_max, 4, "bottom_max");
        assert_eq!(stats.bottom_avg, 3.0, "bottom_avg");
        assert_eq!(stats.avg, 4.5, "avg");
    }
}