netring 0.24.0

High-performance zero-copy packet I/O for Linux (AF_PACKET TPACKET_V3 + AF_XDP)
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
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

//! Drop anomalies below a configured severity tier.

use std::borrow::Cow;

use flowscope::Timestamp;

use crate::anomaly::Severity;
use crate::anomaly::sink::AnomalySink;
use crate::layer::Layer;

/// Drops anomalies whose [`Severity`] is below `floor`.
///
/// Constructed via [`Self::at_least`] / [`Self::info`] /
/// [`Self::warning`] / [`Self::error`] — all `const`.
#[derive(Debug, Clone, Copy)]
pub struct MinSeverity {
    floor: Severity,
}

impl MinSeverity {
    /// Drop anomalies below `floor`.
    pub const fn at_least(floor: Severity) -> Self {
        Self { floor }
    }

    /// Convenience for `at_least(Severity::Info)` — passes everything
    /// (Info is the lowest tier). 0.22 §7.3: spelled out so the floor
    /// is explicit rather than an `at_least(Info)` foot-gun.
    pub const fn info() -> Self {
        Self::at_least(Severity::Info)
    }

    /// Convenience for `at_least(Severity::Warning)`.
    pub const fn warning() -> Self {
        Self::at_least(Severity::Warning)
    }

    /// Convenience for `at_least(Severity::Error)`.
    pub const fn error() -> Self {
        Self::at_least(Severity::Error)
    }
}

impl Layer for MinSeverity {
    fn wrap(self: Box<Self>, inner: Box<dyn AnomalySink>) -> Box<dyn AnomalySink> {
        Box::new(MinSeverityLayered {
            inner,
            floor: self.floor,
        })
    }
}

/// The applied layer — wraps an inner sink + a severity floor.
pub struct MinSeverityLayered {
    inner: Box<dyn AnomalySink>,
    floor: Severity,
}

impl AnomalySink for MinSeverityLayered {
    fn write(
        &mut self,
        kind: &'static str,
        severity: Severity,
        ts: Timestamp,
        key: Option<&dyn crate::anomaly::Key>,
        observations: &[(&'static str, Cow<'_, str>)],
        metrics: &[(&'static str, f64)],
    ) {
        if severity < self.floor {
            return;
        }
        self.inner
            .write(kind, severity, ts, key, observations, metrics);
    }

    fn flush(&mut self) -> Result<(), std::io::Error> {
        self.inner.flush()
    }
}

#[cfg(test)]
mod tests {
    use std::sync::{Arc, Mutex};

    use super::*;

    #[derive(Default)]
    struct Capture {
        seen: Arc<Mutex<Vec<(&'static str, Severity)>>>,
    }
    impl Capture {
        fn list(&self) -> Arc<Mutex<Vec<(&'static str, Severity)>>> {
            Arc::clone(&self.seen)
        }
    }
    impl AnomalySink for Capture {
        fn write(
            &mut self,
            kind: &'static str,
            severity: Severity,
            _ts: Timestamp,
            _key: Option<&dyn crate::anomaly::Key>,
            _observations: &[(&'static str, Cow<'_, str>)],
            _metrics: &[(&'static str, f64)],
        ) {
            self.seen.lock().unwrap().push((kind, severity));
        }
    }

    #[test]
    fn drops_below_floor_passes_above() {
        let inner = Capture::default();
        let calls = inner.list();
        let mut sink: Box<dyn AnomalySink> = Box::new(MinSeverity::warning()).wrap(Box::new(inner));
        sink.begin("I", Severity::Info, Timestamp::new(0, 0)).emit();
        sink.begin("W", Severity::Warning, Timestamp::new(0, 0))
            .emit();
        sink.begin("E", Severity::Error, Timestamp::new(0, 0))
            .emit();
        sink.begin("C", Severity::Critical, Timestamp::new(0, 0))
            .emit();
        let calls = calls.lock().unwrap();
        assert_eq!(
            *calls,
            vec![
                ("W", Severity::Warning),
                ("E", Severity::Error),
                ("C", Severity::Critical)
            ]
        );
    }

    #[test]
    fn at_least_critical_only_lets_critical_through() {
        let inner = Capture::default();
        let calls = inner.list();
        let mut sink: Box<dyn AnomalySink> =
            Box::new(MinSeverity::at_least(Severity::Critical)).wrap(Box::new(inner));
        sink.begin("W", Severity::Warning, Timestamp::new(0, 0))
            .emit();
        sink.begin("E", Severity::Error, Timestamp::new(0, 0))
            .emit();
        sink.begin("C", Severity::Critical, Timestamp::new(0, 0))
            .emit();
        let calls = calls.lock().unwrap();
        assert_eq!(*calls, vec![("C", Severity::Critical)]);
    }
}