|
| 1 | +//! Execution Stats Example: Demonstrates guest call statistics |
| 2 | +//! |
| 3 | +//! This example shows how to inspect timing and termination information |
| 4 | +//! after each guest function call using the `guest-call-stats` feature. |
| 5 | +//! |
| 6 | +//! Features demonstrated: |
| 7 | +//! 1. Wall-clock timing after a normal `handle_event` call |
| 8 | +//! 2. CPU time measurement (when `monitor-cpu-time` is enabled) |
| 9 | +//! 3. Stats with execution monitors — including which monitor fired |
| 10 | +//! 4. Stats update on every call (not cumulative) |
| 11 | +//! |
| 12 | +//! Run with: |
| 13 | +//! cargo run --example execution_stats --features guest-call-stats,monitor-wall-clock,monitor-cpu-time |
| 14 | +//! |
| 15 | +//! Or via Just: |
| 16 | +//! just run-examples |
| 17 | +
|
| 18 | +#![allow(clippy::disallowed_macros)] |
| 19 | + |
| 20 | +use std::time::Duration; |
| 21 | + |
| 22 | +use anyhow::Result; |
| 23 | +use hyperlight_js::{SandboxBuilder, Script}; |
| 24 | + |
| 25 | +fn main() -> Result<()> { |
| 26 | + println!("📊 Execution Stats Example: Guest Call Statistics\n"); |
| 27 | + |
| 28 | + // ── Setup ──────────────────────────────────────────────────────── |
| 29 | + let proto = SandboxBuilder::new().build()?; |
| 30 | + let mut sandbox = proto.load_runtime()?; |
| 31 | + |
| 32 | + // A fast handler that returns immediately |
| 33 | + let fast_handler = Script::from_content( |
| 34 | + r#" |
| 35 | + function handler(event) { |
| 36 | + event.message = "Hello from the guest!"; |
| 37 | + return event; |
| 38 | + } |
| 39 | + "#, |
| 40 | + ); |
| 41 | + |
| 42 | + // A CPU-intensive handler that burns for a configurable duration |
| 43 | + let slow_handler = Script::from_content( |
| 44 | + r#" |
| 45 | + function handler(event) { |
| 46 | + const startTime = Date.now(); |
| 47 | + const runtime = event.runtime || 200; |
| 48 | + let counter = 0; |
| 49 | + while (Date.now() - startTime < runtime) { |
| 50 | + counter++; |
| 51 | + } |
| 52 | + event.counter = counter; |
| 53 | + return event; |
| 54 | + } |
| 55 | + "#, |
| 56 | + ); |
| 57 | + |
| 58 | + // ── Test 1: Basic wall-clock timing ────────────────────────────── |
| 59 | + println!("📊 Test 1: Basic wall-clock timing (fast handler)"); |
| 60 | + |
| 61 | + sandbox.add_handler("fast", fast_handler)?; |
| 62 | + let mut loaded = sandbox.get_loaded_sandbox()?; |
| 63 | + |
| 64 | + // Before any call, stats are None |
| 65 | + assert!(loaded.last_call_stats().is_none()); |
| 66 | + println!(" Before call: stats = None ✅"); |
| 67 | + |
| 68 | + let result = loaded.handle_event("fast", r#"{"name": "World"}"#.to_string(), None)?; |
| 69 | + println!(" Result: {result}"); |
| 70 | + |
| 71 | + let stats = loaded |
| 72 | + .last_call_stats() |
| 73 | + .expect("Stats should be populated after a call"); |
| 74 | + println!(" ⏱️ Wall clock: {:?}", stats.wall_clock); |
| 75 | + print_cpu_time(stats); |
| 76 | + println!( |
| 77 | + " 🏁 Terminated by: {}", |
| 78 | + stats.terminated_by.unwrap_or("(none — completed normally)") |
| 79 | + ); |
| 80 | + |
| 81 | + // ── Test 2: CPU-intensive handler ──────────────────────────────── |
| 82 | + println!("\n📊 Test 2: CPU-intensive handler (200ms burn)"); |
| 83 | + |
| 84 | + let mut sandbox = loaded.unload()?; |
| 85 | + sandbox.clear_handlers(); |
| 86 | + sandbox.add_handler("slow", slow_handler)?; |
| 87 | + let mut loaded = sandbox.get_loaded_sandbox()?; |
| 88 | + |
| 89 | + let _ = loaded.handle_event("slow", r#"{"runtime": 200}"#.to_string(), None)?; |
| 90 | + |
| 91 | + let stats = loaded.last_call_stats().unwrap(); |
| 92 | + println!(" ⏱️ Wall clock: {:?}", stats.wall_clock); |
| 93 | + print_cpu_time(stats); |
| 94 | + println!(" 🏁 Terminated by: (none — completed normally)"); |
| 95 | + |
| 96 | + // ── Test 3: Stats update on each call ──────────────────────────── |
| 97 | + println!("\n📊 Test 3: Stats update on each call (50ms then 150ms)"); |
| 98 | + |
| 99 | + let _ = loaded.handle_event("slow", r#"{"runtime": 50}"#.to_string(), None)?; |
| 100 | + let stats1 = loaded.last_call_stats().unwrap().clone(); |
| 101 | + println!(" Call 1 wall clock: {:?}", stats1.wall_clock); |
| 102 | + |
| 103 | + let _ = loaded.handle_event("slow", r#"{"runtime": 150}"#.to_string(), None)?; |
| 104 | + let stats2 = loaded.last_call_stats().unwrap().clone(); |
| 105 | + println!(" Call 2 wall clock: {:?}", stats2.wall_clock); |
| 106 | + println!( |
| 107 | + " Stats replaced (not cumulative): call2 > call1 = {} ✅", |
| 108 | + stats2.wall_clock > stats1.wall_clock |
| 109 | + ); |
| 110 | + |
| 111 | + // ── Test 4: With monitors — successful completion ──────────────── |
| 112 | + #[cfg(feature = "monitor-wall-clock")] |
| 113 | + { |
| 114 | + use hyperlight_js::WallClockMonitor; |
| 115 | + |
| 116 | + println!("\n📊 Test 4: Monitored call — completes within limit"); |
| 117 | + |
| 118 | + let monitor = WallClockMonitor::new(Duration::from_secs(5))?; |
| 119 | + let _ = loaded.handle_event_with_monitor( |
| 120 | + "slow", |
| 121 | + r#"{"runtime": 50}"#.to_string(), |
| 122 | + &monitor, |
| 123 | + None, |
| 124 | + )?; |
| 125 | + |
| 126 | + let stats = loaded.last_call_stats().unwrap(); |
| 127 | + println!(" ⏱️ Wall clock: {:?}", stats.wall_clock); |
| 128 | + print_cpu_time(stats); |
| 129 | + println!( |
| 130 | + " 🏁 Terminated by: {} ✅", |
| 131 | + stats.terminated_by.unwrap_or("(none — completed normally)") |
| 132 | + ); |
| 133 | + } |
| 134 | + |
| 135 | + // ── Test 5: With monitors — timeout fires ──────────────────────── |
| 136 | + #[cfg(feature = "monitor-wall-clock")] |
| 137 | + { |
| 138 | + use hyperlight_js::WallClockMonitor; |
| 139 | + |
| 140 | + println!("\n📊 Test 5: Monitored call — wall-clock timeout fires"); |
| 141 | + |
| 142 | + let snapshot = loaded.snapshot()?; |
| 143 | + let monitor = WallClockMonitor::new(Duration::from_millis(50))?; |
| 144 | + let result = loaded.handle_event_with_monitor( |
| 145 | + "slow", |
| 146 | + r#"{"runtime": 5000}"#.to_string(), |
| 147 | + &monitor, |
| 148 | + None, |
| 149 | + ); |
| 150 | + |
| 151 | + match result { |
| 152 | + Ok(_) => println!(" ❌ Unexpected: handler completed"), |
| 153 | + Err(_) => { |
| 154 | + let stats = loaded.last_call_stats().unwrap(); |
| 155 | + println!(" ⏱️ Wall clock: {:?}", stats.wall_clock); |
| 156 | + print_cpu_time(stats); |
| 157 | + println!( |
| 158 | + " 💀 Terminated by: {} ✅", |
| 159 | + stats.terminated_by.unwrap_or("(unknown)") |
| 160 | + ); |
| 161 | + println!(" 🔒 Poisoned: {}", loaded.poisoned()); |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + // Recover from poisoned state |
| 166 | + loaded.restore(snapshot.clone())?; |
| 167 | + println!( |
| 168 | + " 📸 Restored from snapshot — poisoned: {}", |
| 169 | + loaded.poisoned() |
| 170 | + ); |
| 171 | + } |
| 172 | + |
| 173 | + // ── Test 6: Combined monitors — CPU monitor wins ───────────────── |
| 174 | + #[cfg(all(feature = "monitor-wall-clock", feature = "monitor-cpu-time"))] |
| 175 | + { |
| 176 | + use hyperlight_js::{CpuTimeMonitor, WallClockMonitor}; |
| 177 | + |
| 178 | + println!("\n📊 Test 6: Combined monitors — CPU monitor fires first"); |
| 179 | + |
| 180 | + let snapshot = loaded.snapshot()?; |
| 181 | + |
| 182 | + // CPU limit is tight (30ms), wall-clock is generous (5s) |
| 183 | + let monitor = ( |
| 184 | + WallClockMonitor::new(Duration::from_secs(5))?, |
| 185 | + CpuTimeMonitor::new(Duration::from_millis(30))?, |
| 186 | + ); |
| 187 | + let result = loaded.handle_event_with_monitor( |
| 188 | + "slow", |
| 189 | + r#"{"runtime": 5000}"#.to_string(), |
| 190 | + &monitor, |
| 191 | + None, |
| 192 | + ); |
| 193 | + |
| 194 | + match result { |
| 195 | + Ok(_) => println!(" ❌ Unexpected: handler completed"), |
| 196 | + Err(_) => { |
| 197 | + let stats = loaded.last_call_stats().unwrap(); |
| 198 | + println!(" ⏱️ Wall clock: {:?}", stats.wall_clock); |
| 199 | + print_cpu_time(stats); |
| 200 | + println!( |
| 201 | + " 💀 Terminated by: {} ✅", |
| 202 | + stats.terminated_by.unwrap_or("(unknown)") |
| 203 | + ); |
| 204 | + } |
| 205 | + } |
| 206 | + |
| 207 | + loaded.restore(snapshot.clone())?; |
| 208 | + println!(" 📸 Restored from snapshot"); |
| 209 | + } |
| 210 | + |
| 211 | + println!("\n🎉 Execution stats example complete!"); |
| 212 | + println!("\n💡 Key Points:"); |
| 213 | + println!(" - last_call_stats() returns None before any call"); |
| 214 | + println!(" - Stats are replaced (not accumulated) on each call"); |
| 215 | + println!(" - wall_clock is always available"); |
| 216 | + println!(" - cpu_time requires the monitor-cpu-time feature"); |
| 217 | + println!(" - terminated_by shows which monitor fired (or None for normal completion)"); |
| 218 | + println!(" - Stats are captured even when the call returns Err"); |
| 219 | + |
| 220 | + Ok(()) |
| 221 | +} |
| 222 | + |
| 223 | +/// Helper to print CPU time, handling the feature-gated `Option`. |
| 224 | +fn print_cpu_time(stats: &hyperlight_js::ExecutionStats) { |
| 225 | + match stats.cpu_time { |
| 226 | + Some(cpu) => println!(" 🖥️ CPU time: {:?}", cpu), |
| 227 | + None => println!(" 🖥️ CPU time: (not available — enable monitor-cpu-time feature)"), |
| 228 | + } |
| 229 | +} |
0 commit comments