moniof 0.1.0

Actix middleware to monitor over-fetching and detect N+1 / overfetch database patterns (Mongo + SQL-agnostic)
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

#[derive(Clone, Debug)]
pub struct MoniOFConfig {
    pub max_total: usize,
    pub max_same_key: usize,
    pub add_response_headers: bool,
    pub log_warnings: bool,
    /// Warn when *cumulative* DB latency exceeds this (ms)
    pub warn_total_db_latency_ms: Option<u128>,
    /// Alert when *cumulative* DB latency is unusually low (ms) but queries > 0
    pub warn_low_total_db_latency_ms: Option<u128>,

    /// OF-style N+1 detection
    pub of_mode: bool,
    /// Minimum times a key must repeat in a request to be considered N+1.
    pub n_plus_one_min_count: usize,
    /// Optional minimum total latency for that key to be considered N+1.
    pub n_plus_one_min_total_ms: Option<u128>,
}

impl Default for MoniOFConfig {
    fn default() -> Self {
        Self {
            max_total: 60,
            max_same_key: 20,
            add_response_headers: true,
            log_warnings: true,
            warn_total_db_latency_ms: None,
            warn_low_total_db_latency_ms: None,

            of_mode: true,
            n_plus_one_min_count: 5,
            n_plus_one_min_total_ms: Some(5),
        }
    }
}