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

use serde::Serialize;

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

/// NetDev contains a network device information parsed from /proc/net/dev
#[derive(Debug, Serialize, Clone, Default)]
pub struct NetDev {
    pub name: String,
    pub rx_bytes: u64,
    pub rx_packets: u64,
    pub rx_errors: u64,
    pub rx_dropped: u64,
    pub rx_fifo: u64,
    pub rx_frame: u64,
    pub rx_compressed: u64,
    pub rx_multicast: u64,
    pub tx_bytes: u64,
    pub tx_packets: u64,
    pub tx_errors: u64,
    pub tx_dropped: u64,
    pub tx_fifo: u64,
    pub tx_collisions: u64,
    pub tx_carrier: u64,
    pub tx_compressed: u64,
}

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

/// collects network device information
/// # Example
/// ```
/// use procsys::net_dev;
///
/// let net_devices = net_dev::collect().expect("network devices");
/// let json_output = serde_json::to_string_pretty(&net_devices).unwrap();
/// println!("{}", json_output);
///
/// ```
pub fn collect() -> CollectResult<Vec<NetDev>> {
    collect_from("/proc/net/dev")
}

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

    let mut line_index = 0;

    for line in utils::read_file_lines(filename)? {
        line_index += 1;

        if line_index <= 2 {
            continue;
        }

        let fields: Vec<&str> = line.trim().split(' ').filter(|s| !s.is_empty()).collect();

        if fields.len() != 17 {
            return Err(MetricError::InvalidFieldNumberError(
                "network".to_string(),
                fields.len(),
                line,
            ));
        }

        let mut net_device = NetDev::new();
        net_device.name = fields[0].trim_matches(':').to_string();
        net_device.rx_bytes = fields[1].parse::<u64>().unwrap_or_default();
        net_device.rx_packets = fields[2].parse::<u64>().unwrap_or_default();
        net_device.rx_errors = fields[3].parse::<u64>().unwrap_or_default();
        net_device.rx_dropped = fields[4].parse::<u64>().unwrap_or_default();
        net_device.rx_fifo = fields[5].parse::<u64>().unwrap_or_default();
        net_device.rx_frame = fields[6].parse::<u64>().unwrap_or_default();
        net_device.rx_compressed = fields[7].parse::<u64>().unwrap_or_default();
        net_device.rx_multicast = fields[8].parse::<u64>().unwrap_or_default();
        net_device.tx_bytes = fields[9].parse::<u64>().unwrap_or_default();
        net_device.tx_packets = fields[10].parse::<u64>().unwrap_or_default();
        net_device.tx_errors = fields[11].parse::<u64>().unwrap_or_default();
        net_device.tx_dropped = fields[12].parse::<u64>().unwrap_or_default();
        net_device.tx_fifo = fields[13].parse::<u64>().unwrap_or_default();
        net_device.tx_collisions = fields[14].parse::<u64>().unwrap_or_default();
        net_device.tx_carrier = fields[15].parse::<u64>().unwrap_or_default();
        net_device.tx_compressed = fields[16].parse::<u64>().unwrap_or_default();

        net_devices.push(net_device);

        line_index += 1;
    }

    Ok(net_devices)
}

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

    #[test]
    fn net_devices() {
        let ndevices =
            collect_from("test_data/fixtures/proc/net/dev").expect("collecting network devices");

        for net_dev in ndevices {
            match net_dev.name.as_str() {
                "vethf345468" => {
                    assert_eq!(net_dev.rx_bytes, 648);
                    assert_eq!(net_dev.rx_packets, 8);
                    assert_eq!(net_dev.rx_errors, 0);
                    assert_eq!(net_dev.rx_dropped, 0);
                    assert_eq!(net_dev.rx_fifo, 0);
                    assert_eq!(net_dev.rx_frame, 0);
                    assert_eq!(net_dev.rx_compressed, 0);
                    assert_eq!(net_dev.rx_multicast, 0);
                    assert_eq!(net_dev.tx_bytes, 438);
                    assert_eq!(net_dev.tx_packets, 5);
                    assert_eq!(net_dev.tx_errors, 0);
                    assert_eq!(net_dev.tx_dropped, 0);
                    assert_eq!(net_dev.tx_fifo, 0);
                    assert_eq!(net_dev.tx_collisions, 0);
                    assert_eq!(net_dev.tx_carrier, 0);
                    assert_eq!(net_dev.tx_compressed, 0);
                }
                "lo" => {
                    assert_eq!(net_dev.rx_bytes, 1664039048);
                    assert_eq!(net_dev.rx_packets, 1566805);
                    assert_eq!(net_dev.rx_errors, 0);
                    assert_eq!(net_dev.rx_dropped, 0);
                    assert_eq!(net_dev.rx_fifo, 0);
                    assert_eq!(net_dev.rx_frame, 0);
                    assert_eq!(net_dev.rx_compressed, 0);
                    assert_eq!(net_dev.rx_multicast, 0);
                    assert_eq!(net_dev.tx_bytes, 1664039048);
                    assert_eq!(net_dev.tx_packets, 1566805);
                    assert_eq!(net_dev.tx_errors, 0);
                    assert_eq!(net_dev.tx_dropped, 0);
                    assert_eq!(net_dev.tx_fifo, 0);
                    assert_eq!(net_dev.tx_collisions, 0);
                    assert_eq!(net_dev.tx_carrier, 0);
                    assert_eq!(net_dev.tx_compressed, 0);
                }
                _ => panic!("invalid network name: {}", net_dev.name),
            }
        }
    }
}