netpulse-cli 0.1.1

A zero-config, single-binary network quality monitor with percentile stats, jitter, and MTR-style traceroute
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
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
// src/main.rs — NetPulse CLI entry point
//
// Architecture (TUI mode):
//   main ─► DNS resolve all targets
//         ─► create AppState (Arc<Mutex<HashMap<target, TargetState>>>)
//         ─► spawn one Tokio task per target (probe loop)
//         ─► tokio::select! { tui::run() | ctrl_c() }
//
// Architecture (stream mode):
//   probe loop ─► ring buffer ─► emit JSON/text to stdout every N probes

use anyhow::{Context, Result};
use clap::{Parser, Subcommand, ValueEnum};
use netpulse::{
    config::{NetPulseConfig, ProbeType},
    export::{prometheus::serve, CsvExporter, JsonExporter},
    probers::{icmp::IcmpProber, tcp::TcpProber, udp::UdpProber, ProbeResult, Prober},
    state::{new_app_state, AppState, TargetState},
    stats::engine::StatsEngine,
};
use std::{
    path::PathBuf,
    sync::{
        atomic::{AtomicBool, Ordering},
        Arc,
    },
    time::Duration,
};
use tokio::time;

// ─── CLI Definition ───────────────────────────────────────────────────────────

#[derive(Parser)]
#[command(
    name = "netpulse",
    version,
    about = "Continuous network quality monitor — RTT percentiles, jitter, and burst-loss in one binary",
    long_about = "Monitor network quality continuously with statistical RTT percentiles,\n\
                  jitter (RFC 3393), burst-loss detection, and packet reorder analysis.\n\
                  Supports ICMP and TCP probing with TUI, JSON, and text output."
)]
struct Cli {
    /// Path to a TOML config file (optional — all flags have defaults)
    #[arg(short, long, global = true, value_name = "FILE")]
    config: Option<PathBuf>,

    #[command(subcommand)]
    command: Commands,
}

#[derive(Subcommand)]
enum Commands {
    /// Monitor one or more targets continuously
    Monitor {
        /// Targets to probe: bare IPs or hostnames for ICMP; host:port for TCP
        #[arg(required = true, value_name = "TARGET")]
        targets: Vec<String>,

        /// Probe interval in milliseconds
        #[arg(short, long, default_value = "1000", value_name = "MS")]
        interval: u64,

        /// Probe timeout in milliseconds
        #[arg(short = 'T', long, default_value = "3000", value_name = "MS")]
        timeout: u64,

        /// Ring buffer window (number of probe samples to retain per target)
        #[arg(short, long, default_value = "300", value_name = "N")]
        window: usize,

        /// Emit a stats summary every N probes (stream modes only)
        #[arg(short, long, default_value = "10", value_name = "N")]
        every: u64,

        /// Probe protocol
        #[arg(short, long, default_value = "icmp", value_name = "TYPE")]
        probe: ProbeTypeArg,

        /// Default port for TCP probing (can also embed port in target: host:port)
        #[arg(short = 'P', long, default_value = "80", value_name = "PORT")]
        port: u16,

        /// Output mode: tui (live UI), json (NDJSON to stdout), text (human-readable)
        #[arg(short, long, default_value = "tui", value_name = "MODE")]
        output: OutputMode,

        /// Pretty-print JSON (only for --output json)
        #[arg(long)]
        pretty: bool,

        /// Append stats to a CSV file (works alongside any output mode)
        #[arg(long, value_name = "FILE")]
        csv: Option<PathBuf>,

        /// Expose Prometheus /metrics on this port (0 = disabled)
        #[arg(long, value_name = "PORT")]
        prometheus: Option<u16>,
    },
    /// Continuously traceroute a single target (MTR style)
    Trace {
        /// Target to trace
        #[arg(required = true, value_name = "TARGET")]
        target: String,

        /// Probe protocol (icmp or udp)
        #[arg(short, long, default_value = "icmp", value_name = "TYPE")]
        probe: ProbeTypeArg,

        /// Probe interval in milliseconds
        #[arg(short, long, default_value = "1000", value_name = "MS")]
        interval: u64,

        /// Probe timeout in milliseconds
        #[arg(short = 'T', long, default_value = "1000", value_name = "MS")]
        timeout: u64,

        /// Ring buffer window (number of probe samples to retain per hop)
        #[arg(short, long, default_value = "300", value_name = "N")]
        window: usize,
    },
}

#[derive(Copy, Clone, PartialEq, ValueEnum)]
enum ProbeTypeArg {
    Icmp,
    Tcp,
    Udp,
}

#[derive(Copy, Clone, PartialEq, ValueEnum)]
enum OutputMode {
    Tui,
    Json,
    Text,
}

// ─── DNS Resolution ───────────────────────────────────────────────────────────

/// Resolve a target string to its first **IPv4** address string (prefers IPv4,
/// falls back to IPv6 if no IPv4 record exists).
///
/// Why prefer IPv4? Our ICMP prober only supports IPv4 raw sockets. On dual-stack
/// systems (Linux with IPv6 enabled), `lookup_host` often returns IPv6 first —
/// which causes google.com to silently time out even though `ping` works fine.
async fn resolve_target_ip(target: &str) -> Result<String> {
    // Already an IP literal — return as-is
    if target.parse::<std::net::IpAddr>().is_ok() {
        return Ok(target.to_string());
    }

    // lookup_host requires a port component
    let lookup_str = if target.contains(':') {
        target.to_string()
    } else {
        format!("{}:0", target)
    };

    let addrs: Vec<std::net::SocketAddr> = tokio::net::lookup_host(&lookup_str)
        .await
        .with_context(|| format!("DNS resolution failed for '{}'", target))?
        .collect();

    if addrs.is_empty() {
        return Err(anyhow::anyhow!("no addresses found for '{}'", target));
    }

    // Prefer IPv4 — only use IPv6 if there is genuinely no A record
    let chosen = addrs.iter().find(|a| a.is_ipv4()).or(addrs.first());
    Ok(chosen.unwrap().ip().to_string())
}

// ─── Entry Point ─────────────────────────────────────────────────────────────

#[tokio::main]
async fn main() -> Result<()> {
    let cli = Cli::parse();

    // Load config file if specified, or check for netpulse.toml in CWD
    let _file_config = if let Some(ref path) = cli.config {
        NetPulseConfig::from_file(path)
            .with_context(|| format!("failed to load config from {:?}", path))?
    } else {
        NetPulseConfig::from_file(&PathBuf::from("netpulse.toml")).unwrap_or_default()
    };

    match cli.command {
        Commands::Monitor {
            targets,
            interval,
            timeout,
            window,
            every,
            probe,
            port,
            output,
            pretty,
            csv,
            prometheus,
        } => {
            let probe_type: ProbeType = match probe {
                ProbeTypeArg::Icmp => ProbeType::Icmp,
                ProbeTypeArg::Tcp => ProbeType::Tcp,
                ProbeTypeArg::Udp => ProbeType::Udp,
            };

            // In TUI mode: resolve silently (no eprintln — avoid bleeding into the TUI).
            // In stream mode: print resolution steps to stderr for visibility.
            let quiet = output == OutputMode::Tui;
            if !quiet {
                eprintln!(
                    "netpulse v{}  ·  resolving targets…",
                    env!("CARGO_PKG_VERSION")
                );
            }
            let mut resolved: Vec<(String, String)> = Vec::new();
            for t in &targets {
                match resolve_target_ip(t).await {
                    Ok(ip) => {
                        if !quiet && &ip != t {
                            eprintln!("  {}{}", t, ip);
                        }
                        resolved.push((t.clone(), ip));
                    }
                    Err(e) => {
                        if !quiet {
                            eprintln!("  {} → ERROR: {}", t, e);
                        }
                        resolved.push((t.clone(), t.clone()));
                    }
                }
            }

            let probe_type_str: &'static str = match probe_type {
                ProbeType::Icmp => "icmp",
                ProbeType::Tcp => "tcp",
                ProbeType::Udp => "udp",
            };

            match output {
                OutputMode::Tui => {
                    run_tui_mode(
                        resolved,
                        probe_type,
                        port,
                        timeout,
                        interval,
                        window,
                        probe_type_str,
                        prometheus,
                    )
                    .await
                }
                OutputMode::Json | OutputMode::Text => {
                    run_stream_mode(
                        resolved, probe_type, port, timeout, interval, window, every, output,
                        pretty, csv, prometheus,
                    )
                    .await
                }
            }
        }
        Commands::Trace {
            target,
            probe,
            interval,
            timeout,
            window,
        } => {
            let probe_type = match probe {
                ProbeTypeArg::Icmp => ProbeType::Icmp,
                ProbeTypeArg::Udp => ProbeType::Udp,
                ProbeTypeArg::Tcp => {
                    eprintln!("TCP tracing is not currently supported. Use 'icmp' or 'udp'.");
                    std::process::exit(1);
                }
            };

            let resolved_ip = resolve_target_ip(&target)
                .await
                .with_context(|| format!("Failed to resolve trace target {:?}", target))?;

            netpulse::trace::run_trace_mode(
                target,
                resolved_ip,
                probe_type,
                timeout,
                interval,
                window,
            )
            .await
        }
    }
}

// ─── TUI Mode ────────────────────────────────────────────────────────────────

#[allow(clippy::too_many_arguments)]
async fn run_tui_mode(
    resolved: Vec<(String, String)>,
    probe_type: ProbeType,
    tcp_port: u16,
    timeout_ms: u64,
    interval_ms: u64,
    window: usize,
    probe_type_str: &'static str,
    prometheus: Option<u16>,
) -> Result<()> {
    let prober: Arc<dyn Prober> = match probe_type {
        ProbeType::Icmp => Arc::new(IcmpProber::new(timeout_ms)),
        ProbeType::Tcp => Arc::new(TcpProber::new(tcp_port, timeout_ms)),
        ProbeType::Udp => Arc::new(UdpProber::new(timeout_ms)),
    };

    // Build shared state — one entry per target
    let state = new_app_state();
    {
        let mut guard = state.lock().unwrap();
        for (name, addr) in &resolved {
            guard.insert(name.clone(), TargetState::new(name, addr, window));
        }
    }

    let display_names: Vec<String> = resolved.iter().map(|(n, _)| n.clone()).collect();

    if let Some(prom_port) = prometheus {
        tokio::spawn(serve(state.clone(), display_names.clone(), prom_port));
    }

    // Shutdown flag shared with all prober tasks
    let running = Arc::new(AtomicBool::new(true));

    // Spawn one prober task per target
    let mut handles = Vec::new();
    for (display_name, resolved_addr) in &resolved {
        let prober = Arc::clone(&prober);
        let state = Arc::clone(&state);
        let running = Arc::clone(&running);
        let display_name = display_name.clone();
        let resolved_addr = resolved_addr.clone();

        let probe_addr = match probe_type {
            // ICMP and UDP both require a bare IPv4 address (raw socket)
            ProbeType::Icmp | ProbeType::Udp => resolved_addr.clone(),
            ProbeType::Tcp => {
                if display_name.contains(':') {
                    display_name.clone()
                } else {
                    format!("{}:{}", display_name, tcp_port)
                }
            }
        };

        let handle = tokio::spawn(async move {
            tui_probe_loop(
                display_name,
                probe_addr,
                prober,
                state,
                interval_ms,
                running,
            )
            .await;
        });
        handles.push(handle);
    }

    // Run TUI until quit; Ctrl-C is handled via tokio::select
    let tui_result = tokio::select! {
        result = netpulse::tui::run(display_names, state, probe_type_str, interval_ms) => result,
        _ = tokio::signal::ctrl_c() => Ok(()),
    };

    // Signal all prober tasks to stop
    running.store(false, Ordering::Relaxed);
    for handle in handles {
        handle.abort();
    }

    tui_result
}

/// Probe loop for TUI mode: writes results to shared AppState.
async fn tui_probe_loop(
    display_name: String,
    probe_addr: String,
    prober: Arc<dyn Prober>,
    state: AppState,
    interval_ms: u64,
    running: Arc<AtomicBool>,
) {
    let mut ticker = time::interval(Duration::from_millis(interval_ms));
    let mut seq: u64 = 0;

    while running.load(Ordering::Relaxed) {
        ticker.tick().await;

        let probe = match prober.probe(&probe_addr, seq, None).await {
            Ok(p) => p,
            Err(netpulse::NetPulseError::InsufficientPrivileges) => {
                eprintln!(
                    "[{}] ICMP requires root or CAP_NET_RAW. Try: sudo netpulse monitor {}",
                    display_name, display_name
                );
                break;
            }
            Err(_) => ProbeResult::loss(&display_name, seq),
        };

        let last_rtt_us = probe.rtt_us;

        {
            let mut guard = state.lock().unwrap();
            if let Some(ts) = guard.get_mut(&display_name) {
                ts.buffer.push(probe);
                ts.seq = seq + 1;
                ts.last_rtt_us = last_rtt_us;
            }
        }

        seq += 1;
    }
}

// ─── Stream Mode (JSON / Text) ────────────────────────────────────────────────

#[allow(clippy::too_many_arguments)]
async fn run_stream_mode(
    resolved: Vec<(String, String)>,
    probe_type: ProbeType,
    tcp_port: u16,
    timeout_ms: u64,
    interval_ms: u64,
    window: usize,
    report_every: u64,
    output: OutputMode,
    pretty: bool,
    csv_path: Option<PathBuf>,
    prometheus: Option<u16>,
) -> Result<()> {
    let prober: Arc<dyn Prober> = match probe_type {
        ProbeType::Icmp => Arc::new(IcmpProber::new(timeout_ms)),
        ProbeType::Tcp => Arc::new(TcpProber::new(tcp_port, timeout_ms)),
        ProbeType::Udp => Arc::new(UdpProber::new(timeout_ms)),
    };

    let state = new_app_state();
    {
        let mut guard = state.lock().unwrap();
        for (name, addr) in &resolved {
            guard.insert(name.clone(), TargetState::new(name, addr, window));
        }
    }

    let display_names: Vec<String> = resolved.iter().map(|(n, _)| n.clone()).collect();

    if let Some(prom_port) = prometheus {
        tokio::spawn(serve(state.clone(), display_names.clone(), prom_port));
    }

    let json_exporter = Arc::new(JsonExporter::new(pretty));
    let csv_exporter = csv_path.map(|p| Arc::new(CsvExporter::new(p)));

    eprintln!(
        "netpulse starting — probe={} interval={}ms targets={}",
        match probe_type {
            ProbeType::Icmp => "icmp",
            ProbeType::Tcp => "tcp",
            ProbeType::Udp => "udp",
        },
        interval_ms,
        resolved
            .iter()
            .map(|(n, _)| n.as_str())
            .collect::<Vec<_>>()
            .join(", ")
    );

    let mut handles = Vec::new();

    for (display_name, resolved_addr) in resolved {
        let prober = Arc::clone(&prober);
        let json_exporter = Arc::clone(&json_exporter);
        let csv_exporter = csv_exporter.clone();
        let state = Arc::clone(&state);

        let probe_addr = match probe_type {
            ProbeType::Icmp | ProbeType::Udp => resolved_addr.clone(),
            ProbeType::Tcp => {
                if display_name.contains(':') {
                    display_name.clone()
                } else {
                    format!("{}:{}", display_name, tcp_port)
                }
            }
        };

        let handle = tokio::spawn(async move {
            stream_probe_loop(
                display_name,
                probe_addr,
                prober,
                state,
                json_exporter,
                csv_exporter,
                interval_ms,
                report_every,
                output,
            )
            .await;
        });
        handles.push(handle);
    }

    tokio::signal::ctrl_c()
        .await
        .context("failed to listen for Ctrl-C")?;
    eprintln!("\nnetpulse stopping.");
    for h in handles {
        h.abort();
    }
    Ok(())
}

/// Stream probe loop: emits JSON or text to stdout on each summary interval.
#[allow(clippy::too_many_arguments)]
async fn stream_probe_loop(
    display_name: String,
    probe_addr: String,
    prober: Arc<dyn Prober>,
    state: AppState,
    json_exporter: Arc<JsonExporter>,
    csv_exporter: Option<Arc<CsvExporter>>,
    interval_ms: u64,
    report_every: u64,
    output: OutputMode,
) {
    let mut ticker = time::interval(Duration::from_millis(interval_ms));
    let mut seq: u64 = 0;

    loop {
        ticker.tick().await;

        let probe = match prober.probe(&probe_addr, seq, None).await {
            Ok(p) => p,
            Err(netpulse::NetPulseError::InsufficientPrivileges) => {
                eprintln!(
                    "[{}] ICMP/UDP requires root. Try: sudo netpulse monitor {}",
                    display_name, display_name
                );
                break;
            }
            Err(_) => ProbeResult::loss(&display_name, seq),
        };

        if output == OutputMode::Text {
            print_probe_text(&probe);
        }

        let last_rtt_us = probe.rtt_us;

        {
            let mut guard = state.lock().unwrap();
            if let Some(ts) = guard.get_mut(&display_name) {
                ts.buffer.push(probe);
                ts.seq = seq + 1;
                ts.last_rtt_us = last_rtt_us;
            }
        }

        seq += 1;

        if seq.is_multiple_of(report_every) {
            let snapshot = {
                let guard = state.lock().unwrap();
                guard.get(&display_name).unwrap().buffer.snapshot()
            };
            let stats = StatsEngine::compute(&display_name, snapshot);

            match output {
                OutputMode::Json => {
                    if let Err(e) = json_exporter.emit(&stats) {
                        eprintln!("json export error: {}", e);
                    }
                }
                OutputMode::Text => print_stats_text(&stats),
                OutputMode::Tui => unreachable!(),
            }

            if let Some(ref csv) = csv_exporter {
                if let Err(e) = csv.emit(&stats) {
                    eprintln!("csv export error: {}", e);
                }
            }
        }
    }
}

// ─── Text Output Helpers ─────────────────────────────────────────────────────

fn print_probe_text(probe: &ProbeResult) {
    match probe.rtt_us {
        Some(rtt) => println!(
            "[{}] seq={} rtt={:.3}ms",
            probe.target,
            probe.seq,
            rtt as f64 / 1000.0
        ),
        None => println!("[{}] seq={} TIMEOUT", probe.target, probe.seq),
    }
}

fn print_stats_text(stats: &netpulse::StatsSnapshot) {
    println!(
        "─── {} | n={} loss={:.1}% | p50={} p95={} p99={} | jitter={} | burst={}",
        stats.target,
        stats.sample_count,
        stats.loss_pct,
        fmt_us(stats.rtt_p50_us),
        fmt_us(stats.rtt_p95_us),
        fmt_us(stats.rtt_p99_us),
        stats
            .jitter_us
            .map(|j| format!("{:.2}ms", j / 1000.0))
            .unwrap_or_else(|| "n/a".to_string()),
        stats.max_burst_loss,
    );
}

fn fmt_us(val: Option<u64>) -> String {
    val.map(|v| format!("{:.2}ms", v as f64 / 1000.0))
        .unwrap_or_else(|| "n/a".to_string())
}