feat: more efficient network stats (#106)

* feat: more efficient network stats

- Add --network-refresh-rate parameter for network stats optimization
- Enhance modular architecture with ProcessedFlags and StatsContext
- Improve CPU temperature detection with better comments

* chore: update dependencies

- anyhow 1.0.99 -> 1.0.100
- clap 4.5.47 -> 4.5.48
- cc 1.2.37 -> 1.2.38
- find-msvc-tools 0.1.1 -> 0.1.2

Author: joncrangle

Cargo.lock

@@ -6,10 +6,10 @@ edition = "2021"
 build = "build.rs"
 
 [dependencies]
-anyhow = "1.0.99"
-clap = { version = "4.5.47", features = ["derive"] }
+anyhow = "1.0.100"
+clap = { version = "4.5.48", features = ["derive"] }
 sysinfo = { version = "0.37.0", default-features = false, features = ["component", "disk", "network", "system"] }
 tokio = { version = "1", features = ["full"] }
 
 [build-dependencies]
-cc = "1.2.37"
+cc = "1.2.38"

Cargo.toml

@@ -36,25 +36,32 @@ A simple system stats event provider for Sketchybar.
 Usage: stats_provider [OPTIONS]
 
 Options:
-  -a, --all                   Get all stats
-  -c, --cpu <CPU>...          Get CPU stats [possible values: count, frequency, temperature, usage]
-  -d, --disk <DISK>...        Get disk stats [possible values: count, free, total, usage, used]
-  -m, --memory <MEMORY>...    Get memory stats [possible values: ram_available, ram_total, ram_usage, ram_used, swp_free, swp_total, swp_usage, swp_used]
-  -n, --network <NETWORK>...  Network rx/tx in KB/s. Specify network interfaces (e.g., -n eth0 en0 lo0). At least one is required.
-  -s, --system <SYSTEM>...    Get system stats [possible values: arch, distro, host_name, kernel_version, name, os_version, long_os_version]
-  -u, --uptime <UPTIME>...    Get uptime stats [possible values: week, day, hour, min, sec]
-  -i, --interval <INTERVAL>   Refresh interval in seconds [default: 5]
-  -b, --bar <BAR>             Bar name (optional)
-      --verbose               Enable verbose output
-  -h, --help                  Print help
-  -V, --version               Print version
+  -a, --all                                        Get all stats
+  -c, --cpu <CPU>...                               Get CPU stats [possible values: count, frequency, temperature, usage]
+  -d, --disk <DISK>...                             Get disk stats [possible values: count, free, total, usage, used]
+  -m, --memory <MEMORY>...                         Get memory stats [possible values: ram_available, ram_total, ram_usage, ram_used, swp_free, swp_total, swp_usage, swp_used]
+  -n, --network <NETWORK>...                       Network rx/tx in KB/s. Specify network interfaces (e.g., -n eth0 en0 lo0). At least one is required.
+  -s, --system <SYSTEM>...                         Get system stats [possible values: arch, distro, host_name, kernel_version, name, os_version, long_os_version]
+  -u, --uptime <UPTIME>...                         Get uptime stats [possible values: week, day, hour, min, sec]
+  -i, --interval <INTERVAL>                        Refresh interval in seconds [default: 5]
+      --network-refresh-rate <NETWORK_REFRESH_RATE> Network refresh rate (how often to refresh network interface list, in stat intervals) [default: 5]
+  -b, --bar <BAR>                                  Bar name (optional)
+      --verbose                                    Enable verbose output
+  -h, --help                                       Print help
+  -V, --version                                    Print version
 ```
 
 Example: trigger event with cpu, disk and ram usage percentages at a refresh interval of 2 seconds:
 ```bash
 stats_provider --cpu usage --disk usage --memory ram_usage --interval 2
 ```
 
+Example: network monitoring with optimized refresh rate:
+```bash
+# Monitor network with interface refresh every 8 stat intervals
+stats_provider --network en0 --interval 3 --network-refresh-rate 8
+```
+
 ### Uptime Usage
 
 The uptime system supports customizable time units. You can specify which units to display:
@@ -77,6 +84,28 @@ Available uptime units:
 
 Units are automatically sorted from largest to smallest, with intelligent carry-over (e.g., excess hours carry into days).
 
+### Network Optimization
+
+The `--network-refresh-rate` parameter controls how frequently the network interface list is refreshed:
+
+```bash
+# Default: refresh network interfaces every 5 stat intervals
+stats_provider --network en0 --interval 2 --network-refresh-rate 5
+
+# More frequent refresh (every 2 intervals) for dynamic environments
+stats_provider --network en0 wlan0 --network-refresh-rate 2
+
+# Less frequent refresh (every 10 intervals) for stable setups to reduce overhead
+stats_provider --network en0 --network-refresh-rate 10
+```
+
+**Benefits:**
+- **Performance**: Reduces system calls by refreshing interface list less frequently
+- **Efficiency**: Network interfaces don't change rapidly, so frequent rescanning is unnecessary
+- **Customizable**: Adjust based on your network environment stability
+
+**Recommendation:** Use higher values (8-15) for stable network setups, lower values (2-5) for environments where interfaces frequently change.
+
 Add the `--verbose` flag to see more detailed output:
 
 ```console

README.md

@@ -1,5 +1,14 @@
+use anyhow::{bail, Result};
 use clap::Parser;
 
+// Default values as constants
+pub const DEFAULT_INTERVAL: u32 = 5;
+pub const DEFAULT_NETWORK_REFRESH_RATE: u32 = 5;
+pub const MIN_INTERVAL: u32 = 1;
+pub const MAX_INTERVAL: u32 = 3600; // 1 hour max
+pub const MIN_NETWORK_REFRESH_RATE: u32 = 1;
+pub const MAX_NETWORK_REFRESH_RATE: u32 = 100;
+
 #[derive(Parser, Debug)]
 #[command(name = "stats_provider", version, about, long_about = None, arg_required_else_help = true)]
 pub struct Cli {
@@ -27,11 +36,18 @@ pub struct Cli {
     #[arg(
         short = 'i',
         long,
-        default_value_t = 5,
+        default_value_t = DEFAULT_INTERVAL,
         help = "Refresh interval in seconds"
     )]
     pub interval: u32,
 
+    #[arg(
+        long,
+        default_value_t = DEFAULT_NETWORK_REFRESH_RATE,
+        help = "Network refresh rate (how often to refresh network interface list, in stat intervals)"
+    )]
+    pub network_refresh_rate: u32,
+
     #[arg(short = 'b', long, help = "Bar name (optional)")]
     pub bar: Option<String>,
 
@@ -43,6 +59,44 @@ pub fn parse_args() -> Cli {
     Cli::parse()
 }
 
+pub fn validate_cli(cli: &Cli) -> Result<()> {
+    // Validate interval
+    if cli.interval < MIN_INTERVAL || cli.interval > MAX_INTERVAL {
+        bail!(
+            "Interval must be between {} and {} seconds, got {}",
+            MIN_INTERVAL,
+            MAX_INTERVAL,
+            cli.interval
+        );
+    }
+
+    // Validate network refresh rate
+    if cli.network_refresh_rate < MIN_NETWORK_REFRESH_RATE
+        || cli.network_refresh_rate > MAX_NETWORK_REFRESH_RATE
+    {
+        bail!(
+            "Network refresh rate must be between {} and {}, got {}",
+            MIN_NETWORK_REFRESH_RATE,
+            MAX_NETWORK_REFRESH_RATE,
+            cli.network_refresh_rate
+        );
+    }
+
+    // Validate that at least one stat type is requested if not using --all
+    if !cli.all
+        && cli.cpu.is_none()
+        && cli.disk.is_none()
+        && cli.memory.is_none()
+        && cli.network.is_none()
+        && cli.system.is_none()
+        && cli.uptime.is_none()
+    {
+        bail!("At least one stat type must be specified, or use --all");
+    }
+
+    Ok(())
+}
+
 pub fn all_cpu_flags() -> Vec<&'static str> {
     vec!["count", "frequency", "temperature", "usage"]
 }