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
use std::fmt::{self, Debug, Formatter};

const METRICS: usize = 5;

///
/// Possible metric types
///
#[derive(Debug, Clone)]
pub enum MetricType {
    Hit = 0,
    Miss,
    KeyInsert,
    KeyUpdate,
    KeyEvict,
}

///
/// Collector of possible metrics types in cache
///
#[derive(Clone)]
pub struct Metrics {
    all: [[usize; 256]; METRICS],
}

impl Metrics {
    ///
    /// Create new metrics
    ///
    pub fn new() -> Self {
        Self {
            all: [[0; 256]; METRICS],
        }
    }

    ///
    /// Insert delta for given metric type
    ///
    pub fn insert(&mut self, metric: MetricType, k: &u64, delta: usize) {
        let idx = (k % 25) * 10;
        let vals = &mut self.all[metric as usize];
        vals[idx as usize] += delta;
    }

    ///
    /// Get collected data about metric type
    ///
    pub fn get(&self, metric: MetricType) -> usize {
        let vals = &self.all[metric as usize];
        vals.iter().sum()
    }

    ///
    /// Collected hits metrics
    ///
    pub fn hits(&self) -> usize {
        self.get(MetricType::Hit)
    }

    ///
    /// Collected misses metrics
    ///
    pub fn misses(&self) -> usize {
        self.get(MetricType::Miss)
    }

    ///
    /// Collected keys inserted metrics
    ///
    pub fn keys_inserted(&self) -> usize {
        self.get(MetricType::KeyInsert)
    }

    ///
    /// Collected keys updated metrics
    ///
    pub fn keys_updated(&self) -> usize {
        self.get(MetricType::KeyUpdate)
    }

    ///
    /// Collected keys evicted metrics
    ///
    pub fn keys_evicted(&self) -> usize {
        self.get(MetricType::KeyEvict)
    }

    ///
    /// Collected hits/misses ratio metrics
    ///
    pub fn ratio(&self) -> f64 {
        let hits = self.hits();
        let misses = self.misses();
        if hits == 0 && misses == 0 {
            return 0.0;
        }
        hits as f64 / (hits + misses) as f64
    }

    ///
    /// Clear all collected metrics data for every category
    ///
    pub fn clear(&mut self) {
        self.all = [[0; 256]; METRICS];
    }
}

impl Default for Metrics {
    fn default() -> Self {
        Self::new()
    }
}

impl Debug for Metrics {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_struct("Metrics")
            .field("hits", &self.hits())
            .field("misses", &self.misses())
            .field("keys_inserted", &self.keys_inserted())
            .field("keys_updated", &self.keys_updated())
            .field("keys_evicted", &self.keys_evicted())
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use crate::metrics::{MetricType, Metrics};

    #[test]
    fn metric_types() {
        let mut metrics = Metrics::new();
        for i in 0..10 {
            metrics.insert(MetricType::Hit, &i, 1);
            metrics.insert(MetricType::Miss, &i, 1);
            metrics.insert(MetricType::KeyInsert, &i, 1);
            metrics.insert(MetricType::KeyUpdate, &i, 1);
            metrics.insert(MetricType::KeyEvict, &i, 1);
        }
        assert_eq!(metrics.hits(), 10);
        assert_eq!(metrics.misses(), 10);
        assert_eq!(metrics.keys_inserted(), 10);
        assert_eq!(metrics.keys_updated(), 10);
        assert_eq!(metrics.keys_evicted(), 10);
    }

    #[test]
    fn hits() {
        let mut metrics = Metrics::new();
        for i in 0..10 {
            metrics.insert(MetricType::Hit, &i, 1);
        }
        assert_eq!(metrics.hits(), 10);
    }

    #[test]
    fn misses() {
        let mut metrics = Metrics::new();
        for i in 0..10 {
            metrics.insert(MetricType::Miss, &i, 1);
        }
        assert_eq!(metrics.misses(), 10);
    }

    #[test]
    fn keys_inserted() {
        let mut metrics = Metrics::new();
        for i in 0..10 {
            metrics.insert(MetricType::KeyInsert, &i, 1);
        }
        assert_eq!(metrics.keys_inserted(), 10);
    }

    #[test]
    fn keys_updated() {
        let mut metrics = Metrics::new();
        for i in 0..10 {
            metrics.insert(MetricType::KeyUpdate, &i, 1);
        }
        assert_eq!(metrics.keys_updated(), 10);
    }

    #[test]
    fn keys_evicted() {
        let mut metrics = Metrics::new();
        for i in 0..10 {
            metrics.insert(MetricType::KeyEvict, &i, 1);
        }
        assert_eq!(metrics.keys_evicted(), 10);
    }

    #[test]
    fn get() {
        let mut metrics = Metrics::new();
        metrics.insert(MetricType::Hit, &1, 1);
        metrics.insert(MetricType::Hit, &2, 2);
        metrics.insert(MetricType::Hit, &3, 3);
        assert_eq!(metrics.get(MetricType::Hit), 6);
    }

    #[test]
    fn ratio() {
        let mut metrics = Metrics::new();
        assert_eq!(0.0, metrics.ratio());
        metrics.insert(MetricType::Hit, &1, 1);
        metrics.insert(MetricType::Hit, &2, 2);
        metrics.insert(MetricType::Miss, &1, 1);
        metrics.insert(MetricType::Miss, &2, 2);
        assert_eq!(metrics.ratio(), 0.5)
    }

    #[test]
    fn clear() {
        let mut metrics = Metrics::new();
        metrics.insert(MetricType::Hit, &1, 1);
        metrics.insert(MetricType::Hit, &2, 2);
        metrics.insert(MetricType::Miss, &1, 1);
        metrics.insert(MetricType::Miss, &2, 2);
        assert_eq!(metrics.ratio(), 0.5);
        metrics.clear();
        assert_eq!(metrics.ratio(), 0.0);
        assert_eq!(metrics.hits(), 0);
        assert_eq!(metrics.misses(), 0);
    }

    #[test]
    fn debug() {
        let mut metrics = Metrics::new();
        metrics.insert(MetricType::Hit, &1, 1);
        metrics.insert(MetricType::Miss, &2, 2);
        metrics.insert(MetricType::KeyEvict, &1, 1);
        metrics.insert(MetricType::KeyUpdate, &2, 2);
        let dbg = format!("{:?}", metrics);
        assert_eq!(
            dbg,
            "Metrics { hits: 1, misses: 2, keys_inserted: 0, keys_updated: 2, keys_evicted: 1 }"
                .to_string()
        );
    }
}