nlink 0.15.1

Async netlink library for Linux network configuration
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

//! Bottleneck Detection Example
//!
//! Demonstrates how to find network bottlenecks by analyzing
//! interface and qdisc statistics.
//!
//! Run: cargo run -p nlink --example diagnostics_bottleneck

use nlink::netlink::{Connection, Route, diagnostics::Diagnostics};

#[tokio::main]
async fn main() -> nlink::Result<()> {
    println!("=== Network Bottleneck Detection ===\n");

    let conn = Connection::<Route>::new()?;
    let diag = Diagnostics::new(conn);

    match diag.find_bottleneck().await? {
        Some(bottleneck) => {
            println!("Bottleneck detected!");
            println!();
            println!("  Location: {}", bottleneck.location);
            println!("  Type: {}", bottleneck.bottleneck_type);
            println!("  Score: {:.2}%", bottleneck.score * 100.0);
            println!();
            println!("  Recommendation: {}", bottleneck.recommendation);
        }
        None => {
            println!("No bottlenecks detected.");
            println!();
            println!("The system appears to be running without significant");
            println!("packet drops or queue overflows.");
        }
    }

    println!("\n=== How Bottleneck Detection Works ===\n");

    println!("The diagnostics module analyzes:");
    println!("  1. Interface statistics (drops, errors)");
    println!("  2. Qdisc statistics (drops, overlimits, backlog)");
    println!("  3. Rate estimator data (bps, pps)");
    println!();
    println!("Bottleneck types:");
    println!("  - QdiscDrops: TC qdisc is dropping packets");
    println!("  - InterfaceDrops: Interface RX/TX drops");
    println!("  - BufferFull: Queue backlog is high");
    println!("  - RateLimited: Hitting rate limit (overlimits)");
    println!("  - HardwareErrors: Interface errors");
    println!();

    println!("=== Example: Monitor for Bottlenecks ===\n");

    println!(
        r#"
    use nlink::netlink::diagnostics::Diagnostics;
    use std::time::Duration;

    let conn = Connection::<Route>::new()?;
    let diag = Diagnostics::new(conn);

    loop {
        if let Some(bottleneck) = diag.find_bottleneck().await? {
            println!("Bottleneck: {} - {}",
                bottleneck.location,
                bottleneck.recommendation);
        }
        tokio::time::sleep(Duration::from_secs(5)).await;
    }
"#
    );

    println!("=== Custom Thresholds ===\n");

    println!(
        r#"
    use nlink::netlink::diagnostics::DiagnosticsConfig;

    // Configure stricter thresholds
    let config = DiagnosticsConfig {
        packet_loss_threshold: 0.001,    // 0.1% loss triggers warning
        error_rate_threshold: 0.0001,    // 0.01% error rate
        qdisc_drop_threshold: 0.001,     // 0.1% qdisc drops
        backlog_threshold: 50_000,       // 50KB backlog
        qlen_threshold: 500,             // 500 packets queued
        skip_loopback: true,
        skip_down: true,
        min_bytes_for_rate: 1000,
    };

    let diag = Diagnostics::with_config(conn, config);
"#
    );

    Ok(())
}