procsys 0.7.0

Rust library to retrieve system, kernel, and process metrics from the pseudo-filesystems /proc and /sys
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
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
279
280
281
282
283
284
285
286

use serde::Serialize;

use crate::{
    error::{CollectResult, MetricError},
    utils,
};

/// NetProtocol represents a single line parsed from /proc/net/protocols
#[derive(Debug, Serialize, Clone, Default)]
pub struct NetProtocol {
    pub name: String,
    pub size: u64,
    pub sockets: i64,
    pub memory: i64,
    pub pressure: Option<bool>,
    pub max_header: u64,
    pub slab: bool,
    pub module_name: String,
    pub capabilities: NetProtocolCapabilities,
}

/// NetProtocolCapabilities contains a list of capabilities for each protocol
#[derive(Debug, Serialize, Clone, Default)]
pub struct NetProtocolCapabilities {
    pub close: bool,
    pub connect: bool,
    pub disconnect: bool,
    pub accept: bool,
    pub ioctl: bool,
    pub init: bool,
    pub destroy: bool,
    pub shutdown: bool,
    pub set_socketopt: bool,
    pub get_socketopt: bool,
    pub send_msg: bool,
    pub recv_msg: bool,
    /// kernel 6.9 does not include send page in anymore
    pub send_page: Option<bool>,
    pub bind: bool,
    pub backlog_rcv: bool,
    pub hash: bool,
    pub unhash: bool,
    pub get_port: bool,
    pub entry_memory_pressure: bool,
}

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

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

/// collects the network protocols information
/// # Example
/// ```
/// use procsys::net_protocols;
///
/// let netprots = net_protocols::collect().expect("network protocols");
/// let json_output = serde_json::to_string_pretty(&netprots).unwrap();
/// println!("{}", json_output);
///
/// ```
pub fn collect() -> CollectResult<Vec<NetProtocol>> {
    collect_from("/proc/net/protocols")
}

fn collect_from(filename: &str) -> CollectResult<Vec<NetProtocol>> {
    let mut netprotos: Vec<NetProtocol> = Vec::new();

    let netprotos_info: Vec<String> = utils::read_file_lines(filename)?;
    let header: Vec<&str> = netprotos_info[0]
        .trim()
        .split(' ')
        .filter(|s| !s.is_empty())
        .collect();

    let sp_included = header[20] == "sp";

    for line in &netprotos_info[1..] {
        let net_info = line.to_owned();
        let net_info_fields: Vec<&str> = net_info
            .trim()
            .split(' ')
            .filter(|s| !s.is_empty())
            .collect();

        if (sp_included && net_info_fields.len() < 27)
            || (!sp_included && net_info_fields.len() < 26)
        {
            return Err(MetricError::InvalidFieldNumberError(
                "net protocols".to_string(),
                net_info_fields.len(),
                line.to_owned(),
            ));
        }

        let mut net_proto = NetProtocol::new();
        net_proto.capabilities = NetProtocolCapabilities::new();

        net_proto.name = net_info_fields[0].to_string();
        net_proto.size = net_info_fields[1].parse::<u64>().unwrap_or_default();
        net_proto.sockets = net_info_fields[2].parse::<i64>().unwrap_or_default();
        net_proto.memory = net_info_fields[3].parse::<i64>().unwrap_or_default();

        if net_info_fields[4] != "NI" {
            net_proto.pressure = Some(net_info_fields[4] == "yes")
        }

        net_proto.max_header = net_info_fields[5].parse::<u64>().unwrap_or_default();
        net_proto.slab = net_info_fields[6] == "yes";
        net_proto.module_name = net_info_fields[7].to_string();

        // capabilities
        let default_y = "y";
        net_proto.capabilities.close = net_info_fields[8] == default_y;
        net_proto.capabilities.connect = net_info_fields[9] == default_y;
        net_proto.capabilities.disconnect = net_info_fields[10] == default_y;
        net_proto.capabilities.accept = net_info_fields[11] == default_y;
        net_proto.capabilities.ioctl = net_info_fields[12] == default_y;
        net_proto.capabilities.init = net_info_fields[13] == default_y;
        net_proto.capabilities.destroy = net_info_fields[14] == default_y;
        net_proto.capabilities.shutdown = net_info_fields[15] == default_y;
        net_proto.capabilities.set_socketopt = net_info_fields[16] == default_y;
        net_proto.capabilities.get_socketopt = net_info_fields[17] == default_y;
        net_proto.capabilities.send_msg = net_info_fields[18] == default_y;
        net_proto.capabilities.recv_msg = net_info_fields[19] == default_y;

        if sp_included {
            net_proto.capabilities.send_page = Some(net_info_fields[20] == default_y);
            net_proto.capabilities.bind = net_info_fields[21] == default_y;
            net_proto.capabilities.backlog_rcv = net_info_fields[22] == default_y;
            net_proto.capabilities.hash = net_info_fields[23] == default_y;
            net_proto.capabilities.unhash = net_info_fields[24] == default_y;
            net_proto.capabilities.get_port = net_info_fields[25] == default_y;
            net_proto.capabilities.entry_memory_pressure = net_info_fields[26] == default_y;
        } else {
            net_proto.capabilities.bind = net_info_fields[20] == default_y;
            net_proto.capabilities.backlog_rcv = net_info_fields[21] == default_y;
            net_proto.capabilities.hash = net_info_fields[22] == default_y;
            net_proto.capabilities.unhash = net_info_fields[23] == default_y;
            net_proto.capabilities.get_port = net_info_fields[24] == default_y;
            net_proto.capabilities.entry_memory_pressure = net_info_fields[25] == default_y;
        }

        netprotos.push(net_proto);
    }

    Ok(netprotos)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn net_protocols() {
        let netprotos = collect_from("test_data/fixtures/proc/net/protocols")
            .expect("collecting network protocols");

        assert_eq!(netprotos.len(), 4);

        for protocol in netprotos {
            match protocol.name.as_str() {
                "PACKET" => {
                    assert_eq!(protocol.size, 1344);
                    assert_eq!(protocol.sockets, 2);
                    assert_eq!(protocol.memory, -1);
                    assert_eq!(protocol.pressure, None);
                    assert_eq!(protocol.max_header, 0);
                    assert_eq!(protocol.slab, false);
                    assert_eq!(protocol.module_name, "kernel");
                    assert_eq!(protocol.capabilities.close, false);
                    assert_eq!(protocol.capabilities.connect, false);
                    assert_eq!(protocol.capabilities.disconnect, false);
                    assert_eq!(protocol.capabilities.accept, false);
                    assert_eq!(protocol.capabilities.ioctl, false);
                    assert_eq!(protocol.capabilities.init, false);
                    assert_eq!(protocol.capabilities.destroy, false);
                    assert_eq!(protocol.capabilities.shutdown, false);
                    assert_eq!(protocol.capabilities.set_socketopt, false);
                    assert_eq!(protocol.capabilities.get_socketopt, false);
                    assert_eq!(protocol.capabilities.send_msg, false);
                    assert_eq!(protocol.capabilities.recv_msg, false);
                    assert_eq!(protocol.capabilities.send_page, Some(false));
                    assert_eq!(protocol.capabilities.bind, false);
                    assert_eq!(protocol.capabilities.backlog_rcv, false);
                    assert_eq!(protocol.capabilities.hash, false);
                    assert_eq!(protocol.capabilities.unhash, false);
                    assert_eq!(protocol.capabilities.get_port, false);
                    assert_eq!(protocol.capabilities.entry_memory_pressure, false);
                }
                "UDPv6" => {
                    assert_eq!(protocol.size, 1216);
                    assert_eq!(protocol.sockets, 10);
                    assert_eq!(protocol.memory, 57);
                    assert_eq!(protocol.pressure, None);
                    assert_eq!(protocol.max_header, 0);
                    assert_eq!(protocol.slab, true);
                    assert_eq!(protocol.module_name, "kernel");
                    assert_eq!(protocol.capabilities.close, true);
                    assert_eq!(protocol.capabilities.connect, true);
                    assert_eq!(protocol.capabilities.disconnect, true);
                    assert_eq!(protocol.capabilities.accept, false);
                    assert_eq!(protocol.capabilities.ioctl, true);
                    assert_eq!(protocol.capabilities.init, true);
                    assert_eq!(protocol.capabilities.destroy, true);
                    assert_eq!(protocol.capabilities.shutdown, false);
                    assert_eq!(protocol.capabilities.set_socketopt, true);
                    assert_eq!(protocol.capabilities.get_socketopt, true);
                    assert_eq!(protocol.capabilities.send_msg, true);
                    assert_eq!(protocol.capabilities.recv_msg, true);
                    assert_eq!(protocol.capabilities.send_page, Some(false));
                    assert_eq!(protocol.capabilities.bind, false);
                    assert_eq!(protocol.capabilities.backlog_rcv, false);
                    assert_eq!(protocol.capabilities.hash, true);
                    assert_eq!(protocol.capabilities.unhash, true);
                    assert_eq!(protocol.capabilities.get_port, true);
                    assert_eq!(protocol.capabilities.entry_memory_pressure, false);
                }
                "TCP" => {
                    assert_eq!(protocol.size, 1984);
                    assert_eq!(protocol.sockets, 93064);
                    assert_eq!(protocol.memory, 1225378);
                    assert_eq!(protocol.pressure, Some(true));
                    assert_eq!(protocol.max_header, 320);
                    assert_eq!(protocol.slab, true);
                    assert_eq!(protocol.module_name, "kernel");
                    assert_eq!(protocol.capabilities.close, true);
                    assert_eq!(protocol.capabilities.connect, true);
                    assert_eq!(protocol.capabilities.disconnect, true);
                    assert_eq!(protocol.capabilities.accept, true);
                    assert_eq!(protocol.capabilities.ioctl, true);
                    assert_eq!(protocol.capabilities.init, true);
                    assert_eq!(protocol.capabilities.destroy, true);
                    assert_eq!(protocol.capabilities.shutdown, true);
                    assert_eq!(protocol.capabilities.set_socketopt, true);
                    assert_eq!(protocol.capabilities.get_socketopt, true);
                    assert_eq!(protocol.capabilities.send_msg, true);
                    assert_eq!(protocol.capabilities.recv_msg, true);
                    assert_eq!(protocol.capabilities.send_page, Some(true));
                    assert_eq!(protocol.capabilities.bind, false);
                    assert_eq!(protocol.capabilities.backlog_rcv, true);
                    assert_eq!(protocol.capabilities.hash, true);
                    assert_eq!(protocol.capabilities.unhash, true);
                    assert_eq!(protocol.capabilities.get_port, true);
                    assert_eq!(protocol.capabilities.entry_memory_pressure, true);
                }
                "NETLINK" => {
                    assert_eq!(protocol.size, 1040);
                    assert_eq!(protocol.sockets, 16);
                    assert_eq!(protocol.memory, -1);
                    assert_eq!(protocol.pressure, None);
                    assert_eq!(protocol.max_header, 0);
                    assert_eq!(protocol.slab, false);
                    assert_eq!(protocol.module_name, "kernel");
                    assert_eq!(protocol.capabilities.close, false);
                    assert_eq!(protocol.capabilities.connect, false);
                    assert_eq!(protocol.capabilities.disconnect, false);
                    assert_eq!(protocol.capabilities.accept, false);
                    assert_eq!(protocol.capabilities.ioctl, false);
                    assert_eq!(protocol.capabilities.init, false);
                    assert_eq!(protocol.capabilities.destroy, false);
                    assert_eq!(protocol.capabilities.shutdown, false);
                    assert_eq!(protocol.capabilities.set_socketopt, false);
                    assert_eq!(protocol.capabilities.get_socketopt, false);
                    assert_eq!(protocol.capabilities.send_msg, false);
                    assert_eq!(protocol.capabilities.recv_msg, false);
                    assert_eq!(protocol.capabilities.send_page, Some(false));
                    assert_eq!(protocol.capabilities.bind, false);
                    assert_eq!(protocol.capabilities.backlog_rcv, false);
                    assert_eq!(protocol.capabilities.hash, false);
                    assert_eq!(protocol.capabilities.unhash, false);
                    assert_eq!(protocol.capabilities.get_port, false);
                    assert_eq!(protocol.capabilities.entry_memory_pressure, false);
                }
                _ => panic!("invalid protocol name: {}", protocol.name),
            }
        }
    }
}