nym-common 1.21.2

Runtime diagnostics for high frequency logging, debugging and error handling utilities
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

// Copyright 2016-2024 Mullvad VPN AB. All Rights Reserved.
// Copyright 2024 Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: GPL-3.0-only

use std::time::{Duration, Instant};

const CALLS_INTERVAL: Duration = Duration::from_secs(5);
const CALLS_THRESHOLD: usize = 1000;

/// Log when a line is hit unusually frequently, that is, over `CALLS_THRESHOLD` times within a
/// period of `CALLS_INTERVAL`.
#[macro_export]
macro_rules! detect_flood {
    () => {{
        static FLOOD: ::std::sync::Mutex<$crate::flood::DetectFlood> =
            ::std::sync::Mutex::new($crate::flood::DetectFlood::new());
        if FLOOD.lock().unwrap().bump() {
            ::tracing::warn!("Flood: {}, line {}, col {}", file!(), line!(), column!());
        }
    }};
}

/// Used to detect code that is running too frequently
pub struct DetectFlood {
    last_clear: Option<Instant>,
    counter: usize,
}

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

impl DetectFlood {
    pub const fn new() -> Self {
        DetectFlood {
            last_clear: None,
            counter: 0,
        }
    }

    pub fn bump(&mut self) -> bool {
        let now = Instant::now();
        let last_clear = self.last_clear.get_or_insert(now);
        if now.saturating_duration_since(*last_clear) >= CALLS_INTERVAL {
            self.last_clear = Some(now);
            self.counter = 0;
            false
        } else {
            self.counter = self.counter.saturating_add(1);
            self.counter == CALLS_THRESHOLD
        }
    }
}