wasmrun 0.20.0

A WebAssembly Runtime
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
//! Agent mode: lightweight, dependency-free metrics registry.
//!
//! Cumulative counters are stored as [`AtomicU64`]; point-in-time gauges
//! (active sessions, in-flight execs, total session disk) are sampled from
//! live state at scrape time and passed into the render functions. Keeping
//! gauges out of the counter set means there is a single source of truth and
//! no drift between a mirrored counter and the thing it tracks.
//!
//! Output is hand-rendered: Prometheus text exposition format (the scrape
//! default) or flat JSON (`?format=json`). No `prometheus`/`metrics` crate —
//! this matches the rest of the agent layer, which hand-rolls its primitives.

use std::sync::atomic::{AtomicU64, Ordering};

/// All metric values use `Relaxed` ordering: each counter is independent and
/// we need atomicity of the increment, not ordering relative to other counters
/// or to surrounding program state. A scrape may observe a set of counters that
/// were never simultaneously "true", which is fine for monitoring.
const ORDER: Ordering = Ordering::Relaxed;

/// Cumulative, monotonic counters incremented at request choke points.
#[derive(Default)]
pub struct Metrics {
    exec_success: AtomicU64,
    exec_error: AtomicU64,
    exec_timeout: AtomicU64,
    /// Sum of execution wall-clock durations (ms) across all terminal outcomes.
    /// Paired with the derived exec count to form a Prometheus summary.
    exec_duration_ms_sum: AtomicU64,
    output_truncated: AtomicU64,
    sessions_created: AtomicU64,
    rejected_concurrency: AtomicU64,
    rejected_payload: AtomicU64,
    rejected_unauthorized: AtomicU64,
    /// Requests/execs rejected by a per-tenant rate cap (session count,
    /// concurrent exec, or requests/min).
    rejected_rate: AtomicU64,
}

/// Point-in-time gauge values, sampled from live state at scrape time rather
/// than mirrored into counters.
pub struct Gauges {
    pub sessions_active: u64,
    pub sessions_total: u64,
    pub exec_in_flight: u64,
    pub sessions_disk_bytes: u64,
}

/// Per-session resource row for the JSON metrics breakdown. Exposed in JSON
/// format only, and only in open (no-auth) mode — in auth mode per-session
/// rows would leak one tenant's footprint to another, so the scrape is capped
/// at global aggregates (see 0.20.5 Q2/Q3 in the implementation plan).
#[derive(serde::Serialize)]
pub struct SessionResourceRow {
    pub id: String,
    pub disk_bytes: u64,
    /// Configured memory ceiling in WASM pages (64 KiB each); `None` = unlimited.
    pub memory_cap_pages: Option<u32>,
}

impl Metrics {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn record_exec_success(&self, dur_ms: u64) {
        self.exec_success.fetch_add(1, ORDER);
        self.exec_duration_ms_sum.fetch_add(dur_ms, ORDER);
    }

    pub fn record_exec_error(&self, dur_ms: u64) {
        self.exec_error.fetch_add(1, ORDER);
        self.exec_duration_ms_sum.fetch_add(dur_ms, ORDER);
    }

    pub fn record_exec_timeout(&self, dur_ms: u64) {
        self.exec_timeout.fetch_add(1, ORDER);
        self.exec_duration_ms_sum.fetch_add(dur_ms, ORDER);
    }

    pub fn record_output_truncated(&self) {
        self.output_truncated.fetch_add(1, ORDER);
    }

    pub fn record_session_created(&self) {
        self.sessions_created.fetch_add(1, ORDER);
    }

    pub fn record_rejected_concurrency(&self) {
        self.rejected_concurrency.fetch_add(1, ORDER);
    }

    pub fn record_rejected_payload(&self) {
        self.rejected_payload.fetch_add(1, ORDER);
    }

    pub fn record_rejected_unauthorized(&self) {
        self.rejected_unauthorized.fetch_add(1, ORDER);
    }

    pub fn record_rejected_rate(&self) {
        self.rejected_rate.fetch_add(1, ORDER);
    }

    /// Consistent-enough snapshot of all counters for rendering.
    fn snapshot(&self) -> Snapshot {
        Snapshot {
            exec_success: self.exec_success.load(ORDER),
            exec_error: self.exec_error.load(ORDER),
            exec_timeout: self.exec_timeout.load(ORDER),
            exec_duration_ms_sum: self.exec_duration_ms_sum.load(ORDER),
            output_truncated: self.output_truncated.load(ORDER),
            sessions_created: self.sessions_created.load(ORDER),
            rejected_concurrency: self.rejected_concurrency.load(ORDER),
            rejected_payload: self.rejected_payload.load(ORDER),
            rejected_unauthorized: self.rejected_unauthorized.load(ORDER),
            rejected_rate: self.rejected_rate.load(ORDER),
        }
    }

    /// Render the Prometheus text exposition format (the scrape default).
    /// `per_session` rows are intentionally not emitted here — Prometheus
    /// labels on session ids would be unbounded-cardinality, and per-session
    /// data is withheld in auth mode anyway.
    pub fn render_prometheus(&self, g: &Gauges) -> String {
        let s = self.snapshot();
        let exec_count = s.exec_success + s.exec_error + s.exec_timeout;
        let mut out = String::with_capacity(2048);

        metric(
            &mut out,
            "wasmrun_agent_exec_total",
            "Total code executions by terminal result.",
            "counter",
            &[
                (&[("result", "success")], s.exec_success),
                (&[("result", "error")], s.exec_error),
                (&[("result", "timeout")], s.exec_timeout),
            ],
        );
        metric(
            &mut out,
            "wasmrun_agent_exec_duration_ms_sum",
            "Sum of execution wall-clock durations in milliseconds.",
            "counter",
            &[(&[], s.exec_duration_ms_sum)],
        );
        metric(
            &mut out,
            "wasmrun_agent_exec_duration_ms_count",
            "Count of executions contributing to the duration sum.",
            "counter",
            &[(&[], exec_count)],
        );
        metric(
            &mut out,
            "wasmrun_agent_output_truncated_total",
            "Executions whose captured output hit the output cap.",
            "counter",
            &[(&[], s.output_truncated)],
        );
        metric(
            &mut out,
            "wasmrun_agent_sessions_created_total",
            "Total sessions created since startup.",
            "counter",
            &[(&[], s.sessions_created)],
        );
        metric(
            &mut out,
            "wasmrun_agent_exec_rejected_total",
            "Executions/requests rejected before doing work, by reason.",
            "counter",
            &[
                (&[("reason", "concurrency")], s.rejected_concurrency),
                (&[("reason", "payload")], s.rejected_payload),
                (&[("reason", "unauthorized")], s.rejected_unauthorized),
                (&[("reason", "rate")], s.rejected_rate),
            ],
        );
        metric(
            &mut out,
            "wasmrun_agent_sessions_active",
            "Currently active (non-expired) sessions.",
            "gauge",
            &[(&[], g.sessions_active)],
        );
        metric(
            &mut out,
            "wasmrun_agent_sessions_total",
            "Total sessions tracked, including expired-but-not-cleaned.",
            "gauge",
            &[(&[], g.sessions_total)],
        );
        metric(
            &mut out,
            "wasmrun_agent_exec_in_flight",
            "Exec workers currently running.",
            "gauge",
            &[(&[], g.exec_in_flight)],
        );
        metric(
            &mut out,
            "wasmrun_agent_sessions_disk_bytes",
            "Total on-disk footprint across active sessions in bytes.",
            "gauge",
            &[(&[], g.sessions_disk_bytes)],
        );
        out
    }

    /// Render a flat JSON object. `per_session` is included only when the
    /// caller passes `Some` (open mode); in auth mode it is `None` so the
    /// scrape stays at global aggregates.
    pub fn render_json(
        &self,
        g: &Gauges,
        per_session: Option<Vec<SessionResourceRow>>,
    ) -> serde_json::Value {
        let s = self.snapshot();
        let exec_count = s.exec_success + s.exec_error + s.exec_timeout;
        let mut obj = serde_json::json!({
            "exec_total": {
                "success": s.exec_success,
                "error": s.exec_error,
                "timeout": s.exec_timeout,
            },
            "exec_duration_ms_sum": s.exec_duration_ms_sum,
            "exec_duration_ms_count": exec_count,
            "output_truncated_total": s.output_truncated,
            "sessions_created_total": s.sessions_created,
            "exec_rejected_total": {
                "concurrency": s.rejected_concurrency,
                "payload": s.rejected_payload,
                "unauthorized": s.rejected_unauthorized,
                "rate": s.rejected_rate,
            },
            "sessions_active": g.sessions_active,
            "sessions_total": g.sessions_total,
            "exec_in_flight": g.exec_in_flight,
            "sessions_disk_bytes": g.sessions_disk_bytes,
        });
        if let Some(rows) = per_session {
            obj["sessions"] = serde_json::to_value(rows).unwrap_or(serde_json::Value::Null);
        }
        obj
    }
}

struct Snapshot {
    exec_success: u64,
    exec_error: u64,
    exec_timeout: u64,
    exec_duration_ms_sum: u64,
    output_truncated: u64,
    sessions_created: u64,
    rejected_concurrency: u64,
    rejected_payload: u64,
    rejected_unauthorized: u64,
    rejected_rate: u64,
}

/// Append one Prometheus metric family: `# HELP`, `# TYPE`, then one sample
/// line per label-set. An empty label slice renders a bare metric line.
fn metric(
    out: &mut String,
    name: &str,
    help: &str,
    kind: &str,
    samples: &[(&[(&str, &str)], u64)],
) {
    out.push_str("# HELP ");
    out.push_str(name);
    out.push(' ');
    out.push_str(help);
    out.push('\n');
    out.push_str("# TYPE ");
    out.push_str(name);
    out.push(' ');
    out.push_str(kind);
    out.push('\n');
    for (labels, value) in samples {
        out.push_str(name);
        if !labels.is_empty() {
            out.push('{');
            for (i, (k, v)) in labels.iter().enumerate() {
                if i > 0 {
                    out.push(',');
                }
                out.push_str(k);
                out.push_str("=\"");
                out.push_str(v);
                out.push('"');
            }
            out.push('}');
        }
        out.push(' ');
        out.push_str(&value.to_string());
        out.push('\n');
    }
}

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

    fn gauges() -> Gauges {
        Gauges {
            sessions_active: 2,
            sessions_total: 3,
            exec_in_flight: 1,
            sessions_disk_bytes: 4096,
        }
    }

    #[test]
    fn counters_increment() {
        let m = Metrics::new();
        m.record_exec_success(10);
        m.record_exec_success(20);
        m.record_exec_error(5);
        m.record_exec_timeout(30);
        m.record_output_truncated();
        m.record_session_created();
        m.record_rejected_concurrency();
        m.record_rejected_payload();
        m.record_rejected_unauthorized();
        m.record_rejected_rate();
        m.record_rejected_rate();

        let s = m.snapshot();
        assert_eq!(s.exec_success, 2);
        assert_eq!(s.exec_error, 1);
        assert_eq!(s.exec_timeout, 1);
        assert_eq!(s.exec_duration_ms_sum, 65); // 10+20+5+30
        assert_eq!(s.output_truncated, 1);
        assert_eq!(s.sessions_created, 1);
        assert_eq!(s.rejected_concurrency, 1);
        assert_eq!(s.rejected_payload, 1);
        assert_eq!(s.rejected_unauthorized, 1);
        assert_eq!(s.rejected_rate, 2);

        // The `rate` reason surfaces in both exposition formats.
        let g = gauges();
        assert!(m
            .render_prometheus(&g)
            .contains("wasmrun_agent_exec_rejected_total{reason=\"rate\"} 2"));
        assert_eq!(m.render_json(&g, None)["exec_rejected_total"]["rate"], 2);
    }

    #[test]
    fn prometheus_render_is_well_formed() {
        let m = Metrics::new();
        m.record_exec_success(40);
        m.record_exec_error(10);
        let text = m.render_prometheus(&gauges());

        // Every metric family has a HELP and TYPE line.
        let help = text.matches("# HELP ").count();
        let typ = text.matches("# TYPE ").count();
        assert_eq!(help, typ);
        assert!(help >= 10);

        // Labeled and gauge samples present with expected values.
        assert!(text.contains("wasmrun_agent_exec_total{result=\"success\"} 1"));
        assert!(text.contains("wasmrun_agent_exec_total{result=\"error\"} 1"));
        assert!(text.contains("wasmrun_agent_exec_duration_ms_sum 50"));
        assert!(text.contains("wasmrun_agent_exec_duration_ms_count 2"));
        assert!(text.contains("wasmrun_agent_sessions_active 2"));
        assert!(text.contains("wasmrun_agent_exec_in_flight 1"));
        assert!(text.contains("wasmrun_agent_sessions_disk_bytes 4096"));

        // No sample line should be empty or malformed (each ends in a number).
        for line in text.lines() {
            if line.starts_with('#') || line.is_empty() {
                continue;
            }
            let last = line.rsplit(' ').next().unwrap();
            assert!(last.parse::<u64>().is_ok(), "bad sample line: {line}");
        }
    }

    #[test]
    fn json_render_shape() {
        let m = Metrics::new();
        m.record_exec_success(40);
        m.record_exec_timeout(60);
        let v = m.render_json(&gauges(), None);

        assert_eq!(v["exec_total"]["success"], 1);
        assert_eq!(v["exec_total"]["timeout"], 1);
        assert_eq!(v["exec_duration_ms_sum"], 100);
        assert_eq!(v["exec_duration_ms_count"], 2);
        assert_eq!(v["sessions_active"], 2);
        assert_eq!(v["sessions_disk_bytes"], 4096);
        // Per-session omitted when None (auth mode / aggregates only).
        assert!(v.get("sessions").is_none());
    }

    #[test]
    fn json_render_includes_per_session_when_present() {
        let m = Metrics::new();
        let rows = vec![SessionResourceRow {
            id: "abc".into(),
            disk_bytes: 1024,
            memory_cap_pages: Some(4096),
        }];
        let v = m.render_json(&gauges(), Some(rows));
        assert_eq!(v["sessions"][0]["id"], "abc");
        assert_eq!(v["sessions"][0]["disk_bytes"], 1024);
        assert_eq!(v["sessions"][0]["memory_cap_pages"], 4096);
    }
}