hotpath 0.29.0

One profiler for CPU, time, memory, SQL, and async code - quickly find and debug performance bottlenecks.
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

#[path = "common/support.rs"]
mod common;

#[cfg(all(test, feature = "hotpath"))]
mod tests {
    use std::collections::BTreeMap;

    use crate::common::example::Example;

    // cargo run -p test-smol-async --example user_metadata --features hotpath
    fn example(format: &str, env_metadata: Option<&str>) -> Example {
        let example = Example::new("test-smol-async", "user_metadata")
            .env("HOTPATH_OUTPUT_FORMAT", format)
            .env("HOTPATH_METRICS_SERVER_OFF", "true")
            .env_remove("HOTPATH_USER_METADATA");
        match env_metadata {
            Some(raw) => example.env("HOTPATH_USER_METADATA", raw),
            None => example,
        }
    }

    fn pairs(map: &BTreeMap<String, String>) -> Vec<(&str, &str)> {
        map.iter().map(|(k, v)| (k.as_str(), v.as_str())).collect()
    }

    #[test]
    fn builder_metadata_lands_in_json_report() {
        let report = example("json", None).report();
        let metadata = report.user_metadata.expect("user_metadata missing");
        assert_eq!(
            pairs(&metadata),
            vec![("source", "builder"), ("team", "core")]
        );
    }

    #[test]
    fn env_metadata_merges_over_builder_metadata() {
        let report = example("json", Some(" source = env ,commit=abc=def, empty= ")).report();
        let metadata = report.user_metadata.expect("user_metadata missing");
        assert_eq!(
            pairs(&metadata),
            vec![
                ("commit", "abc=def"),
                ("empty", ""),
                ("source", "env"),
                ("team", "core"),
            ]
        );
    }

    #[test]
    fn table_output_renders_metadata_table() {
        let stdout = example("table", Some("commit=abc123")).stdout();
        assert!(
            stdout.contains("user_metadata - Custom report metadata."),
            "missing metadata section header:\n{stdout}"
        );
        for (key, value) in [
            ("commit", "abc123"),
            ("source", "builder"),
            ("team", "core"),
        ] {
            assert!(
                stdout.lines().any(|l| l.contains(key) && l.contains(value)),
                "missing row {key}={value}:\n{stdout}"
            );
        }
    }

    #[test]
    fn invalid_env_metadata_panics_at_build() {
        let output = example("json", Some("commit")).output();
        assert!(
            !output.status.success(),
            "expected the example to fail on malformed HOTPATH_USER_METADATA"
        );
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(
            stderr.contains("invalid HOTPATH_USER_METADATA: expected 'key=value', got 'commit'"),
            "unexpected stderr:\n{stderr}"
        );
    }
}