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

use serde::Serialize;

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

const MAX_LIMIT_SIZE: u64 = 18446744073709551615;

enum ProcessLimitsType {
    CPUTime,
    FileSize,
    DataSize,
    StackSize,
    CoreFileSize,
    ResidentSet,
    Processes,
    OpenFiles,
    LockedMemery,
    AddressSpace,
    FileLocks,
    PendingSignals,
    MsqqueueSize,
    NicePriority,
    RealtimePriority,
    RealtimeTimeout,
    Unknown,
}

impl ProcessLimitsType {
    fn from(name: &str) -> ProcessLimitsType {
        match name {
            "Max cpu time" => ProcessLimitsType::CPUTime,
            "Max file size" => ProcessLimitsType::FileSize,
            "Max data size" => ProcessLimitsType::DataSize,
            "Max stack size" => ProcessLimitsType::StackSize,
            "Max core file size" => ProcessLimitsType::CoreFileSize,
            "Max resident set" => ProcessLimitsType::ResidentSet,
            "Max processes" => ProcessLimitsType::Processes,
            "Max open files" => ProcessLimitsType::OpenFiles,
            "Max locked memory" => ProcessLimitsType::LockedMemery,
            "Max address space" => ProcessLimitsType::AddressSpace,
            "Max file locks" => ProcessLimitsType::FileLocks,
            "Max pending signals" => ProcessLimitsType::PendingSignals,
            "Max msgqueue size" => ProcessLimitsType::MsqqueueSize,
            "Max nice priority" => ProcessLimitsType::NicePriority,
            "Max realtime priority" => ProcessLimitsType::RealtimePriority,
            "Max realtime timeout" => ProcessLimitsType::RealtimeTimeout,
            _ => ProcessLimitsType::Unknown,
        }
    }
}

/// ProcessLimits represents the soft limits for each of the process's resource limits
#[derive(Debug, Serialize, Clone, Default)]
pub struct ProcessLimits {
    pub cpu_time: u64,
    pub file_size: u64,
    pub data_size: u64,
    pub stack_size: u64,
    pub core_file_size: u64,
    pub resident_set: u64,
    pub processes: u64,
    pub open_files: u64,
    pub locked_memory: u64,
    pub address_space: u64,
    pub file_locks: u64,
    pub pending_signals: u64,
    pub msgqueue_size: u64,
    pub nice_priority: u64,
    pub realtime_priority: u64,
    pub realtime_timeout: u64,
}

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

impl Process {
    /// limits returns the current soft limits of the process
    pub fn limits(&self) -> CollectResult<ProcessLimits> {
        let mut proc_limits = ProcessLimits::new();
        let proc_limits_path_str = format!("{:?}", self.path());
        let proc_limits_file = format!("{}/limits", proc_limits_path_str.replace("\"", ""));

        let re = match regex::Regex::new(r"(Max \w+\s{0,1}?\w*\s{0,1}\w*)\s{2,}(\w+)\s+(\w+)") {
            Ok(r) => r,
            Err(e) => return Err(MetricError::RegexError(e)),
        };

        for line in utils::read_file_lines(&proc_limits_file)? {
            if line.starts_with("Limit") {
                continue;
            }

            for (_, [item, soft_limit, _]) in re.captures_iter(&line).map(|c| c.extract()) {
                let mut soft_value: u64 = MAX_LIMIT_SIZE;

                if soft_limit != "unlimited" {
                    soft_value = soft_limit.parse::<u64>().unwrap_or_default();
                }

                match ProcessLimitsType::from(item.trim()) {
                    ProcessLimitsType::CPUTime => proc_limits.cpu_time = soft_value,
                    ProcessLimitsType::FileSize => proc_limits.file_size = soft_value,
                    ProcessLimitsType::DataSize => proc_limits.data_size = soft_value,
                    ProcessLimitsType::StackSize => proc_limits.stack_size = soft_value,
                    ProcessLimitsType::CoreFileSize => proc_limits.core_file_size = soft_value,
                    ProcessLimitsType::ResidentSet => proc_limits.resident_set = soft_value,
                    ProcessLimitsType::Processes => proc_limits.processes = soft_value,
                    ProcessLimitsType::OpenFiles => proc_limits.open_files = soft_value,
                    ProcessLimitsType::LockedMemery => proc_limits.locked_memory = soft_value,
                    ProcessLimitsType::AddressSpace => proc_limits.address_space = soft_value,
                    ProcessLimitsType::FileLocks => proc_limits.file_locks = soft_value,
                    ProcessLimitsType::PendingSignals => proc_limits.pending_signals = soft_value,
                    ProcessLimitsType::MsqqueueSize => proc_limits.msgqueue_size = soft_value,
                    ProcessLimitsType::NicePriority => proc_limits.nice_priority = soft_value,
                    ProcessLimitsType::RealtimePriority => {
                        proc_limits.realtime_priority = soft_value
                    }
                    ProcessLimitsType::RealtimeTimeout => proc_limits.realtime_timeout = soft_value,
                    ProcessLimitsType::Unknown => {}
                }
            }
        }

        Ok(proc_limits)
    }
}

#[cfg(test)]
mod tests {
    use super::MAX_LIMIT_SIZE;
    use crate::process::*;
    use std::path::Path;

    #[test]
    fn proc_limits() {
        let proc_path = Path::new("test_data/fixtures/proc");
        let sys_proc = collect_from(proc_path, 26231).expect("running proc 26231");
        let sys_proc_limits = sys_proc.limits().expect("running proc 26231 limits");

        assert_eq!(sys_proc_limits.cpu_time, MAX_LIMIT_SIZE);
        assert_eq!(sys_proc_limits.file_size, MAX_LIMIT_SIZE);
        assert_eq!(sys_proc_limits.data_size, MAX_LIMIT_SIZE);
        assert_eq!(sys_proc_limits.stack_size, 8388608);
        assert_eq!(sys_proc_limits.core_file_size, 0);
        assert_eq!(sys_proc_limits.resident_set, MAX_LIMIT_SIZE);
        assert_eq!(sys_proc_limits.processes, 62898);
        assert_eq!(sys_proc_limits.open_files, 2048);
        assert_eq!(sys_proc_limits.locked_memory, 18446744073708503040);
        assert_eq!(sys_proc_limits.address_space, 8589934592);
        assert_eq!(sys_proc_limits.file_locks, MAX_LIMIT_SIZE);
        assert_eq!(sys_proc_limits.pending_signals, 62898);
        assert_eq!(sys_proc_limits.msgqueue_size, 819200);
        assert_eq!(sys_proc_limits.nice_priority, 0);
        assert_eq!(sys_proc_limits.realtime_priority, 0);
        assert_eq!(sys_proc_limits.realtime_timeout, MAX_LIMIT_SIZE);

        let sys_proc = collect_from(proc_path, 26234).expect("running proc 26234");
        let sys_proc_limits = sys_proc.limits();
        assert_eq!(sys_proc_limits.is_err(), true);
    }
}