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

use serde::Serialize;

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

/// ARPEntry contains a network device information parsed from /proc/net/arp
#[derive(Debug, Serialize, Clone, Default)]
pub struct NetSockStat {
    pub used: Option<isize>,
    pub protocols: Vec<NetSockStatProtocol>,
}

#[derive(Debug, Serialize, Clone, Default)]
pub struct NetSockStatProtocol {
    pub protocol: String,
    pub inuse: isize,
    pub orphan: Option<isize>,
    pub tw: Option<isize>,
    pub alloc: Option<isize>,
    pub mem: Option<isize>,
    pub memory: Option<isize>,
}

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

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

/// collects network device information
/// # Example
/// ```
/// use procsys::net_sockstat;
///
/// let net_sockstat_info = net_sockstat::collect().expect("network sockstat information");
/// let json_output = serde_json::to_string_pretty(&net_sockstat_info).unwrap();
/// println!("sockstat:\n{}", json_output);
///
/// let net_sockstat6_info = net_sockstat::collect6().expect("network sockstat6 information");
/// let json_output = serde_json::to_string_pretty(&net_sockstat6_info).unwrap();
/// println!("sockstat6:\n{}", json_output);
/// ```
pub fn collect() -> CollectResult<NetSockStat> {
    collect_from("/proc/net/sockstat")
}

pub fn collect6() -> CollectResult<NetSockStat> {
    collect_from("/proc/net/sockstat6")
}

fn collect_from(filename: &str) -> CollectResult<NetSockStat> {
    let mut net_sockstat_info = NetSockStat::new();

    for line in utils::read_file_lines(filename)? {
        let fields: Vec<&str> = line.trim().split(':').filter(|s| !s.is_empty()).collect();
        if fields.len() != 2 {
            continue;
        }

        if fields[0].is_empty() || fields[1].is_empty() {
            continue;
        }

        if fields[0] == "sockets" {
            let socket = fields[1].trim().replace("used", "");
            match socket.trim().parse::<isize>() {
                Ok(sv) => net_sockstat_info.used = Some(sv),
                Err(_err) => net_sockstat_info.used = None,
            }
        } else {
            let mut net_sockstat_protocol = NetSockStatProtocol::new();
            let value_fields: Vec<&str> = fields[1]
                .trim()
                .split(' ')
                .filter(|s| !s.is_empty())
                .collect();

            let mut value_field_index = 0;

            while value_field_index < value_fields.len() {
                let val_item = value_fields[value_field_index];

                value_field_index += 1;

                if value_field_index >= value_fields.len() {
                    break;
                }

                let val_value = value_fields[value_field_index];

                value_field_index += 1;

                match val_item {
                    "inuse" => {
                        net_sockstat_protocol.inuse = utils::convert_str_to_isize(val_value)?;
                    }
                    "orphan" => {
                        net_sockstat_protocol.orphan =
                            Some(utils::convert_str_to_isize(val_value)?);
                    }
                    "tw" => {
                        net_sockstat_protocol.tw = Some(utils::convert_str_to_isize(val_value)?);
                    }
                    "alloc" => {
                        net_sockstat_protocol.alloc = Some(utils::convert_str_to_isize(val_value)?);
                    }
                    "mem" => {
                        net_sockstat_protocol.mem = Some(utils::convert_str_to_isize(val_value)?);
                    }
                    "memory" => {
                        net_sockstat_protocol.memory = Some(utils::convert_str_to_isize(val_value)?)
                    }
                    _ => {}
                }
            }

            net_sockstat_protocol.protocol = fields[0].to_string();

            net_sockstat_info.protocols.push(net_sockstat_protocol);
        }
    }

    Ok(net_sockstat_info)
}

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

    #[test]
    fn sockstat_info() {
        let sockstat = collect_from("test_data/fixtures/proc/net/sockstat")
            .expect("sockstat entries information");

        assert_eq!(sockstat.used, Some(1602));

        for protocol in sockstat.protocols {
            match protocol.protocol.as_str() {
                "TCP" => {
                    assert_eq!(protocol.inuse, 35);
                    assert_eq!(protocol.orphan, Some(0));
                    assert_eq!(protocol.tw, Some(4));
                    assert_eq!(protocol.alloc, Some(59));
                    assert_eq!(protocol.mem, Some(22));
                    assert_eq!(protocol.memory, None);
                }
                "UDP" => {
                    assert_eq!(protocol.inuse, 12);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, Some(62));
                    assert_eq!(protocol.memory, None);
                }
                "UDPLITE" => {
                    assert_eq!(protocol.inuse, 0);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, None);
                }
                "RAW" => {
                    assert_eq!(protocol.inuse, 0);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, None);
                }
                "FRAG" => {
                    assert_eq!(protocol.inuse, 0);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, Some(0));
                }
                _ => panic!("invalid protocol: {}", protocol.protocol),
            }
        }

        let sockstat6 = collect_from("test_data/fixtures/proc/net/sockstat6")
            .expect("sockstat entries information");

        assert_eq!(sockstat6.used, None);

        for protocol in sockstat6.protocols {
            match protocol.protocol.as_str() {
                "TCP6" => {
                    assert_eq!(protocol.inuse, 17);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, None);
                }
                "UDP6" => {
                    assert_eq!(protocol.inuse, 9);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, None);
                }
                "UDPLITE6" => {
                    assert_eq!(protocol.inuse, 0);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, None);
                }
                "RAW6" => {
                    assert_eq!(protocol.inuse, 1);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, None);
                }
                "FRAG6" => {
                    assert_eq!(protocol.inuse, 0);
                    assert_eq!(protocol.orphan, None);
                    assert_eq!(protocol.tw, None);
                    assert_eq!(protocol.alloc, None);
                    assert_eq!(protocol.mem, None);
                    assert_eq!(protocol.memory, Some(0));
                }
                _ => panic!("invalid protocol: {}", protocol.protocol),
            }
        }
    }
}