perfgate-types 0.17.0

Versioned receipt/config contracts and JSON schemas for perfgate
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

//! Demonstrates creating and serializing a RunReceipt.

use perfgate_types::{
    BenchMeta, HostInfo, RUN_SCHEMA_V1, RunMeta, RunReceipt, Sample, Stats, ToolInfo, U64Summary,
};

fn main() {
    // Build some samples
    let samples: Vec<Sample> = vec![120, 115, 118, 122, 117]
        .into_iter()
        .map(|wall_ms| Sample {
            wall_ms,
            exit_code: 0,
            warmup: false,
            timed_out: false,
            cpu_ms: None,
            page_faults: None,
            ctx_switches: None,
            max_rss_kb: None,
            io_read_bytes: None,
            io_write_bytes: None,
            network_packets: None,
            energy_uj: None,
            binary_bytes: None,
            stdout: None,
            stderr: None,
        })
        .collect();

    // Summary statistics for wall_ms
    let stats = Stats {
        wall_ms: U64Summary::new(118, 115, 122),
        cpu_ms: None,
        page_faults: None,
        ctx_switches: None,
        max_rss_kb: None,
        io_read_bytes: None,
        io_write_bytes: None,
        network_packets: None,
        energy_uj: None,
        binary_bytes: None,
        throughput_per_s: None,
    };

    // Assemble the receipt
    let receipt = RunReceipt {
        schema: RUN_SCHEMA_V1.to_string(),
        tool: ToolInfo {
            name: "perfgate".to_string(),
            version: "0.1.0".to_string(),
        },
        run: RunMeta {
            id: "run-example-001".to_string(),
            started_at: "2025-01-15T10:00:00Z".to_string(),
            ended_at: "2025-01-15T10:00:05Z".to_string(),
            host: HostInfo {
                os: "linux".to_string(),
                arch: "x86_64".to_string(),
                cpu_count: Some(8),
                memory_bytes: Some(16_000_000_000),
                hostname_hash: None,
            },
        },
        bench: BenchMeta {
            name: "my-benchmark".to_string(),
            cwd: None,
            command: vec!["echo".to_string(), "hello".to_string()],
            repeat: 5,
            warmup: 0,
            work_units: None,
            timeout_ms: None,
        },
        samples,
        stats,
    };

    // Serialize to JSON
    let json = serde_json::to_string_pretty(&receipt).expect("serialize");
    println!("{json}");

    // Verify round-trip
    let parsed: RunReceipt = serde_json::from_str(&json).expect("deserialize");
    assert_eq!(parsed.schema, RUN_SCHEMA_V1);
    assert_eq!(parsed.bench.name, "my-benchmark");
    assert_eq!(parsed.samples.len(), 5);
    println!(
        "\nRound-trip OK: {} samples, median wall_ms = {}",
        parsed.samples.len(),
        parsed.stats.wall_ms.median
    );
}