bmux_performance_plugin_api 0.0.1-alpha.1

Typed public API of the bmux performance plugin (BPDL-generated bindings + settings helpers)
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

// Public, typed contract of the performance plugin.

plugin bmux.performance version 1;

capability PERFORMANCE_READ = bmux.performance.read;
capability PERFORMANCE_WRITE = bmux.performance.write;

interface performance-types {
    enum performance-recording-level {
        off,
        basic,
        detailed,
        trace,
    }

    record performance-runtime-settings {
        recording_level: performance-recording-level,
        window_ms: u64,
        max_events_per_sec: u32,
        max_payload_bytes_per_sec: u64,
    }

    variant metric-target {
        system,
        process { pid: u32 },
        pane { pane_id: uuid },
    }

    enum metric-name {
        cpu-percent,
        memory-bytes,
        process-count,
        disk-read-bytes-per-sec,
        disk-write-bytes-per-sec,
        network-rx-bytes-per-sec,
        network-tx-bytes-per-sec,
    }

    enum theme-header-metric {
        cpu,
        memory,
        process-count,
        disk-read,
        disk-write,
        network-rx,
        network-tx,
    }

    enum metric-target-kind {
        system,
        process,
        pane,
    }

    enum metric-accuracy {
        exact,
        estimated,
    }

    enum cpu-percent-mode {
        @default normalized,
        raw-core-sum,
    }

    enum theme-header-scope {
        @default pane,
        system,
        both,
    }

    enum theme-header-style {
        @default compact,
        detailed,
        heat-only,
    }

    record metric-capability {
        metric: theme-header-metric,
        target: metric-target-kind,
        supported: bool,
        disabled_reason: string?,
        accuracy: metric-accuracy?,
    }

    record theme-header-settings {
        enabled: bool,
        sample_interval_ms: u64,
        scope: theme-header-scope,
        style: theme-header-style,
        cpu_percent_mode: cpu-percent-mode,
        metrics: list<theme-header-metric>,
    }

    record metric-watch {
        id: string,
        target: metric-target,
        metrics: list<metric-name>,
        interval_ms: u64,
        cpu_percent_mode: cpu-percent-mode,
    }

    record system-metrics-snapshot {
        cpu_percent: f32,
        cpu_raw_percent: f32,
        cpu_normalized_percent: f32,
        memory_used_bytes: u64,
        memory_total_bytes: u64,
    }

    record process-metrics-snapshot {
        pid: u32,
        cpu_percent: f32,
        cpu_raw_percent: f32,
        cpu_normalized_percent: f32,
        memory_bytes: u64,
        process_count: u32,
    }

    record pane-metrics-snapshot {
        pane_id: uuid,
        session_id: uuid?,
        pid: u32?,
        process_group_id: i32?,
        cpu_percent: f32,
        cpu_raw_percent: f32,
        cpu_normalized_percent: f32,
        memory_bytes: u64,
        process_count: u32,
        available: bool,
    }

    record metrics-snapshot {
        sampled_at_epoch_ms: u64,
        watches: list<metric-watch>,
        system: system-metrics-snapshot,
        processes: map<u32, process-metrics-snapshot>,
        panes: map<uuid, pane-metrics-snapshot>,
    }

    variant prompt-form-value {
        bool { value: bool },
        text { value: string },
        integer { value: i64 },
        number { value: string },
        single { value: string },
        multi { values: list<string> },
    }

    record prompt-form {
        encoded: bytes,
    }
}

@capability(PERFORMANCE_READ)
interface performance-state {
    query get-settings() -> performance-types.performance-runtime-settings;
    query list-watches() -> list<performance-types.metric-watch>;
    query get-snapshot() -> performance-types.metrics-snapshot;
    query get-metric-capabilities() -> list<performance-types.metric-capability>;
    query get-theme-header-settings() -> performance-types.theme-header-settings;
    query build-theme-header-settings-form() -> performance-types.prompt-form;
}

@capability(PERFORMANCE_WRITE)
interface performance-commands {
    command set-settings(settings: performance-types.performance-runtime-settings)
        -> performance-types.performance-runtime-settings;
    command start-watch(watch: performance-types.metric-watch)
        -> list<performance-types.metric-watch>;
    command stop-watch(watch_id: string) -> unit;
    command set-theme-header-settings(settings: performance-types.theme-header-settings)
        -> performance-types.theme-header-settings;
    command apply-theme-header-settings-form(values: map<string, performance-types.prompt-form-value>)
        -> performance-types.theme-header-settings;
}

interface performance-events {
    variant performance-event {
        settings-updated { settings: performance-types.performance-runtime-settings },
    }

    events performance-event;
}

interface metric-events {
    variant metric-event {
        snapshot-updated { sampled_at_epoch_ms: u64 },
    }

    events metric-event;
}

interface metrics-state {
    @state events performance-types.metrics-snapshot;
}