mcrx-core 0.2.5

Runtime-agnostic and portable multicast receiver library for IPv4 and IPv6 ASM/SSM.
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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
#[path = "common/recv_args.rs"]
mod recv_args;

#[cfg(feature = "metrics")]
use mcrx_core::jsonl::{
    HARDWARE_ARTIFACT_TYPE, MetricsJsonlOutputConfig, NETWORK_ARTIFACT_TYPE,
    append_jsonl_sample_row, header_json, infer_node_id_from_path, unix_timestamp_secs,
};
use mcrx_core::{Context, SubscriptionConfig};
#[cfg(feature = "metrics")]
use mcrx_core::{
    ContextMetricsDelta, ContextMetricsSampler, ContextMetricsSnapshot, HardwareMetricsDelta,
    HardwareMetricsSampler, HardwareMetricsSnapshot,
};
#[cfg(feature = "metrics")]
use serde_json::{Map, Value, json};
use std::env;
use std::net::IpAddr;
#[cfg(feature = "metrics")]
use std::path::{Path, PathBuf};
use std::process;
use std::thread;
use std::time::Duration;
#[cfg(feature = "metrics")]
use std::time::Instant;

const POLL_INTERVAL: Duration = Duration::from_millis(10);
const MAX_PREVIEW_LEN: usize = 64;
#[cfg(feature = "metrics")]
const RECEIVER_PRODUCER: &str = "mcrx-core/mcrx_recv";

fn main() {
    if let Err(err) = run() {
        eprintln!("mcrx-recv: {err}");
        process::exit(1);
    }
}

fn run() -> Result<(), String> {
    let args: Vec<String> = env::args().collect();

    if args.len() < 3 {
        print_usage(&args[0]);
        return Err("invalid arguments".to_string());
    }

    let parsed = match recv_args::parse_receive_cli_args(&args) {
        Ok(parsed) => parsed,
        Err(err) => {
            print_usage(&args[0]);
            return Err(err);
        }
    };
    let group = parsed.group;
    let dst_port = parsed.dst_port;
    let source = parsed.source;
    let interface = parsed.interface;
    let interface_index = parsed.interface_index;

    let mut config = match source {
        Some(source) => SubscriptionConfig::ssm_ip(group, source, dst_port),
        None => SubscriptionConfig::asm_ip(group, dst_port),
    };
    config.interface = interface;
    config.interface_index = interface_index;

    let mut ctx = Context::new();
    let subscription_id = ctx
        .add_subscription(config)
        .map_err(|err| format!("failed to add subscription: {err}"))?;
    ctx.join_subscription(subscription_id)
        .map_err(|err| format!("failed to join subscription: {err}"))?;

    println!("mcrx-recv ready");
    println!("  group:      {group}");
    println!("  dst_port:   {dst_port}");
    println!("  source:     {}", source_string(source));
    println!(
        "  interface:  {}",
        interface_string(interface, interface_index)
    );
    println!("  sub_id:     {}", subscription_id.0);

    println!();
    println!("waiting for packets ...");

    #[cfg(feature = "metrics")]
    let summary_interval = summary_interval_from_env();
    #[cfg(feature = "metrics")]
    let summary_output =
        summary_output_from_env(group, dst_port, source, interface, interface_index)?;
    #[cfg(feature = "metrics")]
    let mut metrics_sampler = ContextMetricsSampler::new();
    #[cfg(feature = "metrics")]
    let _ = metrics_sampler.sample(ctx.metrics_snapshot());
    #[cfg(feature = "metrics")]
    let mut hardware_metrics_sampler = init_hardware_metrics_sampler()?;
    #[cfg(feature = "metrics")]
    let mut next_summary_at = summary_interval.map(|interval| Instant::now() + interval);

    loop {
        match ctx
            .try_recv_any()
            .map_err(|err| format!("receive failed: {err}"))?
        {
            Some(packet) => {
                println!(
                    "[recv] sub={} src={} group={} dst_port={} len={}",
                    packet.subscription_id.0,
                    packet.source,
                    packet.group,
                    packet.dst_port,
                    packet.payload.len()
                );

                println!("       payload: {}", format_payload(&packet.payload));
            }
            None => {
                thread::sleep(POLL_INTERVAL);
            }
        }
        #[cfg(feature = "metrics")]
        if let (Some(interval), Some(deadline)) = (summary_interval, next_summary_at)
            && Instant::now() >= deadline
        {
            let snapshot = ctx.metrics_snapshot();

            if let Some(delta) = metrics_sampler.sample(snapshot.clone()) {
                if let Some(output) = &summary_output {
                    write_metrics_summary_jsonl(&snapshot, &delta, output)
                        .map_err(|err| format!("failed to write metrics summary: {err}"))?;
                } else {
                    print_metrics_summary(&snapshot, &delta);
                }
            }

            if let Some(hardware_sampler) = hardware_metrics_sampler.as_mut()
                && let Some(hardware_snapshot) = capture_hardware_metrics_snapshot()?
                && let Some(delta) = hardware_sampler.sample(hardware_snapshot.clone())
            {
                if let Some(output) = &summary_output {
                    write_hardware_metrics_summary_jsonl(&hardware_snapshot, &delta, output)
                        .map_err(|err| {
                            format!("failed to write hardware metrics summary: {err}")
                        })?;
                } else {
                    print_hardware_metrics_summary(&hardware_snapshot, &delta);
                }
            }

            next_summary_at = Some(Instant::now() + interval);
        }
    }
}

fn source_string(source: Option<IpAddr>) -> String {
    match source {
        Some(source) => source.to_string(),
        None => "any".to_string(),
    }
}

fn interface_string(interface: Option<IpAddr>, interface_index: Option<u32>) -> String {
    match (interface, interface_index) {
        (Some(IpAddr::V6(interface)), Some(interface_index)) => {
            format!("{interface}%{interface_index}")
        }
        (Some(interface), _) => interface.to_string(),
        (None, Some(interface_index)) => format!("ifindex:{interface_index}"),
        (None, None) => "default".to_string(),
    }
}

fn format_payload(payload: &[u8]) -> String {
    match std::str::from_utf8(payload) {
        Ok(text) => truncate_preview(text, MAX_PREVIEW_LEN),
        Err(_) => {
            let preview_len = payload.len().min(16);
            let hex_preview = payload[..preview_len]
                .iter()
                .map(|byte| format!("{byte:02x}"))
                .collect::<Vec<_>>()
                .join(" ");

            if payload.len() > preview_len {
                format!("0x{hex_preview} ... ({} bytes total)", payload.len())
            } else {
                format!("0x{hex_preview}")
            }
        }
    }
}

fn truncate_preview(text: &str, max_len: usize) -> String {
    let char_count = text.chars().count();
    if char_count <= max_len {
        return text.to_string();
    }

    let truncated: String = text.chars().take(max_len).collect();
    format!("{truncated}...")
}

#[cfg(feature = "metrics")]
fn summary_interval_from_env() -> Option<Duration> {
    let raw = env::var("MCRX_METRICS_SUMMARY_SECS").ok()?;
    let secs = raw.parse::<u64>().ok()?;
    if secs == 0 {
        None
    } else {
        Some(Duration::from_secs(secs))
    }
}

#[cfg(feature = "metrics")]
fn summary_file_from_env() -> Option<PathBuf> {
    let raw = env::var("MCRX_METRICS_SUMMARY_FILE").ok()?;
    if raw.trim().is_empty() {
        None
    } else {
        Some(PathBuf::from(raw))
    }
}

#[cfg(feature = "metrics")]
fn hardware_summary_file_path(network_path: &Path) -> PathBuf {
    let parent = network_path.parent().map(PathBuf::from).unwrap_or_default();
    let stem = network_path
        .file_stem()
        .and_then(|stem| stem.to_str())
        .unwrap_or("metrics");
    let extension = network_path.extension().and_then(|ext| ext.to_str());

    let file_name = match extension {
        Some(ext) if !ext.is_empty() => format!("{stem}_hardware.{ext}"),
        _ => format!("{stem}_hardware"),
    };

    parent.join(file_name)
}

#[cfg(feature = "metrics")]
fn metrics_node_id_from_env() -> Option<String> {
    env::var("MCRX_METRICS_NODE_ID")
        .ok()
        .map(|value| value.trim().to_string())
        .filter(|value| !value.is_empty())
}

#[cfg(feature = "metrics")]
fn metrics_flags_from_env() -> Result<Map<String, Value>, String> {
    let raw = match env::var("MCRX_METRICS_FLAGS_JSON") {
        Ok(raw) => raw,
        Err(_) => return Ok(Map::new()),
    };

    let trimmed = raw.trim();
    if trimmed.is_empty() {
        return Ok(Map::new());
    }

    let parsed: Value = serde_json::from_str(trimmed)
        .map_err(|err| format!("MCRX_METRICS_FLAGS_JSON must be valid JSON: {err}"))?;

    match parsed {
        Value::Object(map) => Ok(map),
        _ => Err("MCRX_METRICS_FLAGS_JSON must be a JSON object".to_string()),
    }
}

#[cfg(feature = "metrics")]
fn build_receiver_metrics_flags(
    group: IpAddr,
    dst_port: u16,
    source: Option<IpAddr>,
    interface: Option<IpAddr>,
    interface_index: Option<u32>,
) -> Result<Map<String, Value>, String> {
    let mut flags = Map::new();
    flags.insert(
        "transport".to_string(),
        Value::String("udp-multicast".to_string()),
    );
    flags.insert("role".to_string(), Value::String("receiver".to_string()));
    flags.insert(
        "multicast_group".to_string(),
        Value::String(group.to_string()),
    );
    flags.insert("multicast_port".to_string(), json!(dst_port));
    flags.insert(
        "multicast_interface".to_string(),
        Value::String(interface_string(interface, interface_index)),
    );
    flags.insert(
        "join_mode".to_string(),
        Value::String(if source.is_some() { "ssm" } else { "asm" }.to_string()),
    );
    flags.insert(
        "source_filter".to_string(),
        Value::String(
            if source.is_some() {
                "source-specific"
            } else {
                "any"
            }
            .to_string(),
        ),
    );
    flags.insert("batch_receive_enabled".to_string(), Value::Bool(false));

    if let Some(source) = source {
        flags.insert("source_addr".to_string(), Value::String(source.to_string()));
    }

    for (key, value) in metrics_flags_from_env()? {
        flags.entry(key).or_insert(value);
    }

    Ok(flags)
}

#[cfg(feature = "metrics")]
fn summary_output_from_env(
    group: IpAddr,
    dst_port: u16,
    source: Option<IpAddr>,
    interface: Option<IpAddr>,
    interface_index: Option<u32>,
) -> Result<Option<MetricsJsonlOutputConfig>, String> {
    let Some(network_path) = summary_file_from_env() else {
        return Ok(None);
    };

    Ok(Some(MetricsJsonlOutputConfig {
        node_id: metrics_node_id_from_env()
            .unwrap_or_else(|| infer_node_id_from_path(&network_path)),
        flags: build_receiver_metrics_flags(group, dst_port, source, interface, interface_index)?,
        network_path,
    }))
}

#[cfg(feature = "metrics")]
fn init_hardware_metrics_sampler() -> Result<Option<HardwareMetricsSampler>, String> {
    #[cfg(any(target_os = "linux", target_os = "macos"))]
    {
        let mut sampler = HardwareMetricsSampler::new();
        let _ = sampler.sample(
            HardwareMetricsSnapshot::capture_current_process()
                .map_err(|err| format!("failed to capture initial hardware metrics: {err}"))?,
        );
        Ok(Some(sampler))
    }

    #[cfg(not(any(target_os = "linux", target_os = "macos")))]
    {
        Ok(None)
    }
}

#[cfg(feature = "metrics")]
fn capture_hardware_metrics_snapshot() -> Result<Option<HardwareMetricsSnapshot>, String> {
    #[cfg(any(target_os = "linux", target_os = "macos"))]
    {
        HardwareMetricsSnapshot::capture_current_process()
            .map(Some)
            .map_err(|err| format!("failed to capture hardware metrics: {err}"))
    }

    #[cfg(not(any(target_os = "linux", target_os = "macos")))]
    {
        Ok(None)
    }
}

#[cfg(feature = "metrics")]
fn write_metrics_summary_jsonl(
    snapshot: &ContextMetricsSnapshot,
    delta: &ContextMetricsDelta,
    output: &MetricsJsonlOutputConfig,
) -> Result<(), std::io::Error> {
    let header = header_json(
        NETWORK_ARTIFACT_TYPE,
        RECEIVER_PRODUCER,
        &output.node_id,
        snapshot.captured_at,
        &output.flags,
    );
    let sample = json!({
        "ts": unix_timestamp_secs(snapshot.captured_at),
        "interval_secs": delta.interval_secs,
        "active_subscriptions": snapshot.active_subscriptions,
        "joined_subscriptions": snapshot.joined_subscriptions,
        "packets_received_total": snapshot.total_packets_received,
        "bytes_received_total": snapshot.total_bytes_received,
        "packets_received_delta": delta.packets_received,
        "bytes_received_delta": delta.bytes_received,
        "would_block_count_total": snapshot.total_would_block_count,
        "would_block_count_delta": delta.would_block_count,
        "receive_errors_total": snapshot.total_receive_errors,
        "receive_errors_delta": delta.receive_errors,
        "join_count_total": snapshot.total_join_count,
        "join_count_delta": delta.join_count,
        "leave_count_total": snapshot.total_leave_count,
        "leave_count_delta": delta.leave_count,
        "batch_calls_total": snapshot.batch_calls,
        "batch_calls_delta": delta.batch_calls,
        "batch_packets_received_total": snapshot.batch_packets_received,
        "batch_packets_received_delta": delta.batch_packets_received,
        "packets_per_sec": delta.packets_per_sec(),
        "bytes_per_sec": delta.bytes_per_sec(),
        "would_block_per_sec": delta.would_block_per_sec(),
        "receive_errors_per_sec": delta.receive_errors_per_sec(),
    });

    append_jsonl_sample_row(&output.network_path, &header, &sample)
}

#[cfg(feature = "metrics")]
fn write_hardware_metrics_summary_jsonl(
    snapshot: &HardwareMetricsSnapshot,
    delta: &HardwareMetricsDelta,
    output: &MetricsJsonlOutputConfig,
) -> Result<(), std::io::Error> {
    let hardware_path = hardware_summary_file_path(&output.network_path);
    let header = header_json(
        HARDWARE_ARTIFACT_TYPE,
        RECEIVER_PRODUCER,
        &output.node_id,
        snapshot.captured_at,
        &output.flags,
    );
    let sample = json!({
        "ts": unix_timestamp_secs(snapshot.captured_at),
        "interval_secs": delta.interval_secs,
        "cpu_user_secs": delta.cpu_user_secs,
        "cpu_system_secs": delta.cpu_system_secs,
        "cpu_total_secs": delta.cpu_total_secs,
        "cpu_util_percent": delta.cpu_util_percent,
        "rss_bytes": delta.rss_bytes,
        "virtual_memory_bytes": delta.virtual_memory_bytes,
        "thread_count": delta.thread_count,
        "open_fds": delta.open_fds,
        "page_faults_minor": delta.page_faults_minor,
        "page_faults_major": delta.page_faults_major,
        "ctx_switches_voluntary": delta.ctx_switches_voluntary,
        "ctx_switches_involuntary": delta.ctx_switches_involuntary,
    });

    append_jsonl_sample_row(&hardware_path, &header, &sample)
}

#[cfg(feature = "metrics")]
fn print_metrics_summary(snapshot: &ContextMetricsSnapshot, delta: &ContextMetricsDelta) {
    println!("[metrics]");
    println!("  interval_secs:         {:.3}", delta.interval_secs);
    println!("  active_subscriptions:  {}", snapshot.active_subscriptions);
    println!("  joined_subscriptions:  {}", snapshot.joined_subscriptions);
    println!(
        "  packets_received_total: {}",
        snapshot.total_packets_received
    );
    println!("  packets_received_delta: {}", delta.packets_received);
    println!(
        "  bytes_received_total:   {}",
        snapshot.total_bytes_received
    );
    println!("  bytes_received_delta:   {}", delta.bytes_received);
    println!(
        "  would_block_count_total: {}",
        snapshot.total_would_block_count
    );
    println!("  would_block_count_delta: {}", delta.would_block_count);
    println!(
        "  receive_errors_total:   {}",
        snapshot.total_receive_errors
    );
    println!("  receive_errors_delta:   {}", delta.receive_errors);
    println!("  join_count_total:       {}", snapshot.total_join_count);
    println!("  join_count_delta:       {}", delta.join_count);
    println!("  leave_count_total:      {}", snapshot.total_leave_count);
    println!("  leave_count_delta:      {}", delta.leave_count);
    println!("  batch_calls_total:      {}", snapshot.batch_calls);
    println!("  batch_calls_delta:      {}", delta.batch_calls);
    println!(
        "  batch_packets_received_total: {}",
        snapshot.batch_packets_received
    );
    println!(
        "  batch_packets_received_delta: {}",
        delta.batch_packets_received
    );
    println!("  packets_per_sec:       {:.3}", delta.packets_per_sec());
    println!("  bytes_per_sec:         {:.3}", delta.bytes_per_sec());
    println!(
        "  would_block_per_sec:   {:.3}",
        delta.would_block_per_sec()
    );
    println!(
        "  recv_errors_per_sec:   {:.3}",
        delta.receive_errors_per_sec()
    );
}

#[cfg(feature = "metrics")]
fn print_hardware_metrics_summary(
    _snapshot: &HardwareMetricsSnapshot,
    delta: &HardwareMetricsDelta,
) {
    println!("[hardware]");
    println!("  interval_secs:              {:.3}", delta.interval_secs);
    println!("  cpu_user_secs:              {:.6}", delta.cpu_user_secs);
    println!("  cpu_system_secs:            {:.6}", delta.cpu_system_secs);
    println!("  cpu_total_secs:             {:.6}", delta.cpu_total_secs);
    println!(
        "  cpu_util_percent:           {:.3}",
        delta.cpu_util_percent
    );
    println!("  rss_bytes:                  {}", delta.rss_bytes);
    println!(
        "  virtual_memory_bytes:       {}",
        delta.virtual_memory_bytes
    );
    println!("  thread_count:               {}", delta.thread_count);
    println!("  open_fds:                   {}", delta.open_fds);
    println!("  page_faults_minor:          {}", delta.page_faults_minor);
    println!("  page_faults_major:          {}", delta.page_faults_major);
    println!(
        "  ctx_switches_voluntary:     {}",
        delta.ctx_switches_voluntary
    );
    println!(
        "  ctx_switches_involuntary:   {}",
        delta.ctx_switches_involuntary
    );
}

fn print_usage(program: &str) {
    eprintln!("Usage:");
    eprintln!("  {program} <group> <dst_port> [source] [interface]");
    eprintln!("  {program} <group> <dst_port> [--source <source>] [--interface <interface>]");
    eprintln!();
    eprintln!("Examples:");
    eprintln!("  {program} 239.1.2.3 5000");
    eprintln!("  {program} 232.1.2.3 5000 192.168.1.10");
    eprintln!("  {program} 232.1.2.3 5000 192.168.1.10 192.168.1.20");
    eprintln!("  {program} ff01::1234 5000");
    eprintln!("  {program} ff01::1234 5000 --interface ::1");
    eprintln!("  {program} ff32::8000:1234 5000 --interface fe80::1%7");
    eprintln!("  {program} ff32::8000:1234 5000 --interface fe80::1%en0");
    eprintln!("  {program} ff3e::8000:1234 5000 --interface 7");
    eprintln!("  {program} ff31::8000:1234 5000 <sender-ipv6> --interface <receiver-ipv6>");
    eprintln!();
    eprintln!("Notes:");
    eprintln!("  - omit <source> for ASM");
    eprintln!("  - provide <source> for SSM");
    eprintln!(
        "  - use --interface for ASM when you want to set the join interface without also setting a source"
    );
    eprintln!("  - <interface> selects the local join interface address");
    eprintln!(
        "  - for IPv6, <interface> may also be a scoped address like fe80::1%7 or fe80::1%en0, or a numeric interface index"
    );
    eprintln!("  - for IPv6 SSM, use ff3x::/32 groups such as ff31::8000:1234 or ff3e::8000:1234");
    eprintln!(
        "  - for IPv6 SSM, pass --interface <receiver-ipv6-or-ifindex>; this is required on macOS"
    );
    eprintln!("  - for link-local IPv6 SSM groups such as ff32::/16, send from a fe80:: source");

    #[cfg(feature = "metrics")]
    {
        eprintln!();
        eprintln!("Metrics (when built with --features metrics):");
        eprintln!("  MCRX_METRICS_SUMMARY_SECS=<n>   emit a delta metrics summary every n seconds");
        eprintln!(
            "  MCRX_METRICS_NODE_ID=<id>       override JSONL header node_id (defaults to parent dir, then file stem)"
        );
        eprintln!(
            "  MCRX_METRICS_FLAGS_JSON=<json>  merge extra JSON object fields into the header flags map"
        );
        #[cfg(any(target_os = "linux", target_os = "macos"))]
        eprintln!(
            "  MCRX_METRICS_SUMMARY_FILE=<p>   write single-header JSONL network metrics to <p> and process hardware metrics to a sibling *_hardware file"
        );
        #[cfg(not(any(target_os = "linux", target_os = "macos")))]
        eprintln!(
            "  MCRX_METRICS_SUMMARY_FILE=<p>   write single-header JSONL network metrics to <p>"
        );
    }
}

#[cfg(all(test, feature = "metrics"))]
mod tests {
    use super::*;
    use mcrx_core::jsonl::HEIMDALL_JSONL_SCHEMA;
    use std::fs;
    use std::time::{Duration, SystemTime, UNIX_EPOCH};

    #[test]
    fn metrics_jsonl_writes_one_header_then_compact_samples() {
        let parent_name = format!(
            "mcrx_recv_metrics_node_{}",
            SystemTime::now()
                .duration_since(UNIX_EPOCH)
                .unwrap_or(Duration::ZERO)
                .as_nanos()
        );
        let parent = std::env::temp_dir().join(&parent_name);
        fs::create_dir_all(&parent).unwrap();
        let path = parent.join("network_metrics.jsonl");
        let mut flags = Map::new();
        flags.insert("role".to_string(), Value::String("receiver".to_string()));
        flags.insert(
            "multicast_group".to_string(),
            Value::String("ff3e::8000:1234".to_string()),
        );
        let output = MetricsJsonlOutputConfig {
            node_id: infer_node_id_from_path(&path),
            flags,
            network_path: path.clone(),
        };

        let snapshot = ContextMetricsSnapshot {
            subscriptions_added: 1,
            subscriptions_removed: 0,
            active_subscriptions: 1,
            joined_subscriptions: 1,
            total_packets_received: 10,
            total_bytes_received: 1000,
            total_would_block_count: 4,
            total_receive_errors: 2,
            total_join_count: 3,
            total_leave_count: 1,
            batch_calls: 7,
            batch_packets_received: 10,
            captured_at: SystemTime::UNIX_EPOCH + Duration::from_secs(123),
        };

        let delta = ContextMetricsDelta {
            interval_secs: 2.0,
            packets_received: 5,
            bytes_received: 600,
            would_block_count: 1,
            receive_errors: 1,
            join_count: 1,
            leave_count: 0,
            batch_calls: 2,
            batch_packets_received: 5,
        };

        write_metrics_summary_jsonl(&snapshot, &delta, &output).unwrap();

        let later_snapshot = ContextMetricsSnapshot {
            total_packets_received: 15,
            total_bytes_received: 1600,
            total_would_block_count: 5,
            total_receive_errors: 2,
            total_join_count: 3,
            total_leave_count: 1,
            batch_calls: 8,
            batch_packets_received: 15,
            captured_at: SystemTime::UNIX_EPOCH + Duration::from_secs(125),
            ..snapshot.clone()
        };
        let later_delta = ContextMetricsDelta {
            interval_secs: 2.0,
            packets_received: 5,
            bytes_received: 600,
            would_block_count: 1,
            receive_errors: 0,
            join_count: 0,
            leave_count: 0,
            batch_calls: 1,
            batch_packets_received: 5,
        };

        write_metrics_summary_jsonl(&later_snapshot, &later_delta, &output).unwrap();

        let contents = fs::read_to_string(&path).unwrap();
        let lines = contents
            .lines()
            .filter(|line| !line.trim().is_empty())
            .collect::<Vec<_>>();

        assert_eq!(lines.len(), 3);

        let header: Value = serde_json::from_str(lines[0]).unwrap();
        assert_eq!(header["schema"], HEIMDALL_JSONL_SCHEMA);
        assert_eq!(header["artifact_type"], NETWORK_ARTIFACT_TYPE);
        assert_eq!(header["producer"], RECEIVER_PRODUCER);
        assert_eq!(header["node_id"], parent_name);
        assert!(header["flags"].is_object());

        for sample_line in &lines[1..] {
            let sample: Value = serde_json::from_str(sample_line).unwrap();
            assert!(sample.get("schema").is_none());
            assert!(sample.get("artifact_type").is_none());
            assert!(sample.get("node_id").is_none());
            assert!(sample.get("producer").is_none());
            assert!(sample.get("flags").is_none());
        }

        let sample = &lines[1];
        assert!(sample.contains("\"packets_received_total\":10"));
        assert!(sample.contains("\"bytes_received_total\":1000"));
        assert!(sample.contains("\"packets_received_delta\":5"));
        assert!(sample.contains("\"bytes_received_delta\":600"));
        assert!(sample.contains("\"would_block_count_total\":4"));
        assert!(sample.contains("\"would_block_count_delta\":1"));
        assert!(sample.contains("\"receive_errors_total\":2"));
        assert!(sample.contains("\"receive_errors_delta\":1"));
        assert!(sample.contains("\"join_count_total\":3"));
        assert!(sample.contains("\"join_count_delta\":1"));
        assert!(sample.contains("\"leave_count_total\":1"));
        assert!(sample.contains("\"leave_count_delta\":0"));
        assert!(sample.contains("\"batch_calls_total\":7"));
        assert!(sample.contains("\"batch_calls_delta\":2"));
        assert!(sample.contains("\"batch_packets_received_total\":10"));
        assert!(sample.contains("\"batch_packets_received_delta\":5"));
        assert!(!sample.contains("\"packets_received\":"));
        assert!(!sample.contains("\"bytes_received\":"));
        assert!(!sample.contains("\"would_block_count\":"));
        assert!(!sample.contains("\"receive_errors\":"));
        assert!(!sample.contains("\"join_count\":"));
        assert!(!sample.contains("\"leave_count\":"));
        assert!(!sample.contains("\"batch_calls\":"));
        assert!(!sample.contains("\"batch_packets_received\":"));

        let _ = fs::remove_file(&path);
        let _ = fs::remove_dir(parent);
    }

    #[test]
    fn node_id_inference_prefers_parent_dir_over_file_stem() {
        let path = PathBuf::from("/tmp/client-0001/network-metrics.jsonl");
        assert_eq!(infer_node_id_from_path(&path), "client-0001");
    }

    #[test]
    fn metrics_jsonl_rejects_mismatched_existing_header_metadata() {
        let parent = std::env::temp_dir().join(format!(
            "mcrx_recv_metrics_mismatch_{}",
            SystemTime::now()
                .duration_since(UNIX_EPOCH)
                .unwrap_or(Duration::ZERO)
                .as_nanos()
        ));
        fs::create_dir_all(&parent).unwrap();
        let path = parent.join("network_metrics.jsonl");

        let stale_header = json!({
            "schema": HEIMDALL_JSONL_SCHEMA,
            "artifact_type": NETWORK_ARTIFACT_TYPE,
            "node_id": "old-node",
            "producer": RECEIVER_PRODUCER,
            "created_at": 1.0,
            "flags": {
                "role": "receiver",
                "multicast_group": "239.1.2.3",
            }
        });
        fs::write(&path, format!("{stale_header}\n")).unwrap();

        let mut flags = Map::new();
        flags.insert("role".to_string(), Value::String("receiver".to_string()));
        flags.insert(
            "multicast_group".to_string(),
            Value::String("239.1.2.99".to_string()),
        );
        let output = MetricsJsonlOutputConfig {
            node_id: "client-0002".to_string(),
            flags,
            network_path: path.clone(),
        };

        let snapshot = ContextMetricsSnapshot {
            subscriptions_added: 1,
            subscriptions_removed: 0,
            active_subscriptions: 1,
            joined_subscriptions: 1,
            total_packets_received: 1,
            total_bytes_received: 10,
            total_would_block_count: 0,
            total_receive_errors: 0,
            total_join_count: 1,
            total_leave_count: 0,
            batch_calls: 1,
            batch_packets_received: 1,
            captured_at: SystemTime::UNIX_EPOCH + Duration::from_secs(1),
        };
        let delta = ContextMetricsDelta {
            interval_secs: 1.0,
            packets_received: 1,
            bytes_received: 10,
            would_block_count: 0,
            receive_errors: 0,
            join_count: 1,
            leave_count: 0,
            batch_calls: 1,
            batch_packets_received: 1,
        };

        let err = write_metrics_summary_jsonl(&snapshot, &delta, &output).unwrap_err();
        assert_eq!(err.kind(), std::io::ErrorKind::InvalidData);

        let _ = fs::remove_file(&path);
        let _ = fs::remove_dir(parent);
    }
}