Skip to main content

macOS internet connection monitor

Project description

mb-netwatch

macOS internet connection monitor. Tracks warm + cold latency, VPN status, and public IP at a glance via a menu bar icon.

Status: Under active development.

What it monitors

Five types of checks run continuously in the background:

  • Latency (warm) — HTTP probes over a reused keep-alive session, every 2 seconds (steady-state probe — first response wins)
  • Latency (cold) — HTTP probes over a fresh session (full TCP+TLS setup), every 10 seconds (catches connection-setup failures a warm probe hides)
  • DNS — UDP query to every system resolver in parallel, every 10 seconds (reachability + cached-answer speed of the resolvers macOS is actually using right now)
  • VPN status — tunnel interface and routing table detection every 10 seconds
  • Public IP — address and country code via plain-text IP services every 60 seconds

See docs/probes.md for detailed algorithms, endpoints, and design rationale.

CLI commands

  • mb-netwatch — TUI dashboard (default when no command given)
  • mb-netwatch probe — one-shot connectivity probe, print result
  • mb-netwatch probed — run continuous background measurements
  • mb-netwatch tray — run menu bar UI process
  • mb-netwatch start [probed|tray] — start processes in the background (no argument = both)
  • mb-netwatch stop [probed|tray] — stop background processes (no argument = both)
  • mb-netwatch raycast install — install Raycast Script Commands (see docs/raycast.md)

Architecture

General CLI application architecture patterns are described in docs/cli-architecture.md. Database schema and storage rules are in docs/db.md. Below is the project-specific structure.

Core (core/)

Central application layer. Holds database, business logic, and probe implementations. Consumers never import from core/ directly — they receive a Core instance and access everything through it:

  • core.db — database (reads and writes)
  • core.config — application configuration
  • core.service — business logic (running probes, storing results)

Consumers

Three independent consumers of Core:

  • CLI (cli/) — command-line interface. Each command receives Core and Output via CoreContext.
  • TUI (tui/) — Textual terminal dashboard. Polls core.db for latest results and renders a live view with warm and cold latency sparklines, VPN/IP status, and recent events.
  • Daemon (daemon.py) — long-running background process. Orchestrates scheduling (loops, timers, signals) and delegates all probe/store logic to core.service.
  • Tray (tray.py) — macOS menu bar UI. Polls core.db for latest results and updates the icon.

Processes

Two long-running processes in normal operation:

  • probed (mb-netwatch probed) — runs the daemon; measures warm latency every 2 s, cold latency every 10 s, VPN status every 10 s, public IP every 60 s; writes to SQLite via core.service.
  • tray (mb-netwatch tray) — UI only; reads latest samples from SQLite via core.db, updates menu bar icon and dropdown.

The tray must not perform network probing directly. This separation keeps UI responsive and simplifies debugging.

Storage

SQLite database at ~/.local/mb-netwatch/netwatch.db (WAL mode). See docs/db.md for schema, deduplication strategy, and retention rules.

Configuration

Optional TOML config at ~/.local/mb-netwatch/config.toml. The file is not created automatically — create it only if you want to override defaults. All keys are optional — only specify what you want to change.

[probed]
warm_latency_interval = 2.0    # seconds between warm-latency probes (default: 2.0)
cold_latency_interval = 10.0   # seconds between cold-latency probes (default: 10.0)
vpn_interval = 10.0            # seconds between VPN status checks (default: 10.0)
ip_interval = 60.0             # seconds between public IP lookups (default: 60.0)
dns_interval = 10.0            # seconds between DNS probes (default: 10.0)
purge_interval = 3600.0        # seconds between old-data purge runs (default: 3600.0)
warm_latency_timeout = 5.0     # HTTP timeout for warm-latency probes (default: 5.0)
cold_latency_timeout = 5.0     # HTTP timeout for cold-latency probes (default: 5.0)
ip_timeout = 5.0               # HTTP timeout for IP/country lookups (default: 5.0)
dns_timeout = 2.0              # per-resolver UDP query timeout for DNS probes (default: 2.0)
retention_days = 30            # days to keep raw rows before purging (default: 30)

[warm_latency_threshold]
ok_ms = 300              # warm latency below this → OK (default: 300)
slow_ms = 800            # warm latency below this → SLOW, at or above → BAD (default: 800)
stale_seconds = 10.0     # seconds before warm data is considered stale (default: 10.0)

[cold_latency_threshold]
ok_ms = 600              # cold latency below this → OK (default: 600)
slow_ms = 1500           # cold latency below this → SLOW, at or above → BAD (default: 1500)
stale_seconds = 30.0     # seconds before cold data is considered stale (default: 30.0)

[dns_threshold]
stale_seconds = 30.0     # seconds before DNS data is considered stale (default: 30.0)

[tray]
poll_interval = 2.0      # seconds between tray DB polls (default: 2.0)

[tui]
poll_interval = 0.5            # seconds between TUI dashboard DB polls (default: 0.5)
sparkline_history_max = 300    # max latency readings drawn per sparkline (default: 300)

The menu bar shows a fixed-width 3-character title: 2-letter country code + status symbol ( OK / SLOW / BAD / DOWN), e.g. US●. Click the menu bar icon to see the exact latency in the dropdown. If probed stops writing data, the symbol changes to (en dash) after stale_seconds seconds (default 10). While waiting for the first data, a middle dot · is displayed.

Installation

uv tool install mb-netwatch
mb-netwatch start

Tech stack

  • Python 3.14
  • aiohttp — HTTP probes
  • psutil — network interface inspection for VPN detection
  • mm-clikit — CLI toolkit (Typer enhancements, SQLite, process management)
  • mm-pymac — macOS menu bar app

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mb_netwatch-0.2.1.tar.gz (47.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mb_netwatch-0.2.1-py3-none-any.whl (50.8 kB view details)

Uploaded Python 3

File details

Details for the file mb_netwatch-0.2.1.tar.gz.

File metadata

  • Download URL: mb_netwatch-0.2.1.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mb_netwatch-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d8e064c11b2ef120a13b45ccbbcf55176c233d902d7d5cf1c382ba1aff9c9028
MD5 6547df31086e855250b8d45aa12576ed
BLAKE2b-256 2cc22dfc3388d4f3378af8976bc1648529a3372bc78c2057aae77db9ff559d84

See more details on using hashes here.

File details

Details for the file mb_netwatch-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: mb_netwatch-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 50.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mb_netwatch-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 73cb6004239d7768692ad4aa5acadf77dc2ea95ceb4b1974da408ff9f0e8227d
MD5 5fdb0191d49eea4e4f59daf321da85a4
BLAKE2b-256 f39f710bf3eaa97ce9e78dd04fac3670966f7b4664f4e9e8ff0aad20d2d20c8b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page