greggd 1.0.5

Lightweight Linux, macOS, and Windows metrics daemon that exposes a read-only JSON API for the gregg client.
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

//! Shared validation and bounding for native drive results.

use gregg_protocol::v2::{DriveMetrics, MAX_DRIVE_ENTRIES, MAX_DRIVE_NAME_BYTES};

/// An owned, platform-neutral candidate before wire normalization.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) struct DriveCandidate {
    pub(crate) identity: String,
    pub(crate) name: String,
    pub(crate) total_bytes: u64,
    pub(crate) total_free_bytes: u64,
    pub(crate) available_bytes: u64,
}

/// Convert valid native candidates into deterministic, bounded wire records.
pub(crate) fn normalize(mut candidates: Vec<DriveCandidate>) -> Vec<DriveMetrics> {
    candidates.retain(|candidate| {
        !candidate.identity.is_empty()
            && !candidate.name.is_empty()
            && candidate.name.len() <= MAX_DRIVE_NAME_BYTES
            && candidate.total_bytes > 0
            && candidate.total_free_bytes <= candidate.total_bytes
            && candidate.available_bytes <= candidate.total_bytes
    });

    candidates.sort_by(|left, right| {
        left.identity
            .cmp(&right.identity)
            .then_with(|| left.name.cmp(&right.name))
    });
    candidates.dedup_by(|left, right| left.identity == right.identity);
    candidates.sort_by(|left, right| left.name.cmp(&right.name));
    candidates.truncate(MAX_DRIVE_ENTRIES);

    candidates
        .into_iter()
        .map(|candidate| DriveMetrics {
            name: candidate.name,
            used_bytes: candidate.total_bytes - candidate.total_free_bytes,
            total_bytes: candidate.total_bytes,
            available_bytes: Some(candidate.available_bytes),
        })
        .collect()
}

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

    #[test]
    fn normalization_rejects_invalid_values_deduplicates_and_bounds() {
        let mut candidates = vec![
            DriveCandidate {
                identity: "same".to_string(),
                name: "/z".to_string(),
                total_bytes: 10,
                total_free_bytes: 2,
                available_bytes: 2,
            },
            DriveCandidate {
                identity: "same".to_string(),
                name: "/a".to_string(),
                total_bytes: 10,
                total_free_bytes: 3,
                available_bytes: 3,
            },
            DriveCandidate {
                identity: "bad".to_string(),
                name: "/bad".to_string(),
                total_bytes: 1,
                total_free_bytes: 2,
                available_bytes: 2,
            },
        ];
        candidates.extend((0..(MAX_DRIVE_ENTRIES + 2)).map(|index| DriveCandidate {
            identity: format!("id-{index}"),
            name: format!("/{index}"),
            total_bytes: 10,
            total_free_bytes: 1,
            available_bytes: 1,
        }));

        let normalized = normalize(candidates);
        assert_eq!(normalized.len(), MAX_DRIVE_ENTRIES);
        assert_eq!(normalized[0].name, "/0");
        assert!(normalized
            .iter()
            .all(|drive| drive.used_bytes <= drive.total_bytes));
        assert!(!normalized.iter().any(|drive| drive.name == "/bad"));
    }
}