joule-profiler-source-cgroup 0.1.1

CGroup v2 metrics source for joule-profiler
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

use std::{path::PathBuf, time::Duration};

use serde::Deserialize;

const DEFAULT_POLL_INTERVAL: Duration = Duration::from_millis(10);

fn default_poll_interval() -> Duration {
    DEFAULT_POLL_INTERVAL
}

fn default_true() -> bool {
    true
}

fn default_cgroup_name() -> String {
    format!("joule-profiler-{}", std::process::id())
}

/// Configuration for the cgroup metric source.
#[derive(Debug, Clone, Deserialize)]
pub struct CgroupConfig {
    /// Path to cgroup v2 hierarchy (usually `/sys/fs/cgroup`).
    pub cgroup_root: Option<PathBuf>,

    /// Name of the created cgroup for the monitored process.
    #[serde(default = "default_cgroup_name")]
    pub cgroup_name: String,

    /// Background polling interval.
    #[serde(default = "default_poll_interval", with = "humantime_serde")]
    pub poll_interval: Duration,

    /// Whether the source must attach the process pid to the cgroup or not.
    #[serde(default = "default_true")]
    pub attach_pid: bool,

    /// Whether the cgroup is already created or if the source must create it itself.
    #[serde(default = "default_true")]
    pub create_cgroup: bool,
}

impl Default for CgroupConfig {
    fn default() -> Self {
        Self {
            cgroup_root: None,
            cgroup_name: default_cgroup_name(),
            poll_interval: DEFAULT_POLL_INTERVAL,
            attach_pid: true,
            create_cgroup: true,
        }
    }
}