Skip to content

Commit 5dd751e

Browse files
committed
feat: add color-coded anomaly highlighting and adjust debug logging defaults
1 parent 1ccdcfc commit 5dd751e

2 files changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@ By comparing gateway-to-WAN tests against local-machine-to-WAN tests, you can be
1313
- Runs gateway-based Ping tests to measure the quality of the direct ISP connection.
1414
- Optionally runs a gateway-based Speed Test.
1515
- Runs local Ping tests from the machine executing the script to both the gateway and the internet.
16-
- Runs local Speed Tests using the **official Ookla Speedtest CLI** for accurate, reliable results.
16+
- Runs local Speed Tests using the **official Ookla Speedtest CLI** for accurate, reliable results:
17+
- Download & Upload Bandwidth
18+
- Ping, Jitter, and Packet Loss
19+
- Bufferbloat (latency under load) with calculated delta vs. idle latency
1720
- Runs in headless mode, so no browser window is required.
1821
- Schedules tests to run at a configurable interval.
22+
- Provides color-coded console output, highlighting anomalous results (e.g., high latency, packet loss) for at-a-glance diagnosis.
1923
- Appends combined results to a single, local CSV log file, creating headers if the file is new or empty.
2024
- Captures detailed Wi-Fi metrics on macOS (signal, noise, channel, etc.) - see the [Advanced Configuration](#advanced-configuration) section for details.
2125
- All configuration is organized in the `config.py` file.
@@ -51,6 +55,7 @@ All configuration has been moved to the **`config.py`** file for easy editing.
5155
- `LOG_FILE`: The name of the CSV file for storing results.
5256
- `RUN_INTERVAL_MINUTES`: How often the script should run.
5357
- `HEADLESS_MODE`: Set to `True` to run the browser invisibly in the background.
58+
- `ENABLE_DEBUG_LOGGING`: Set to `True` to include verbose debug logs in the console and log output.
5459

5560

5661
### Gateway Test Configuration
@@ -67,6 +72,16 @@ All configuration has been moved to the **`config.py`** file for easy editing.
6772
- `RUN_LOCAL_SPEED_TEST`: Set to `True` to run a speed test from your computer using the Ookla CLI.
6873
- `RUN_LOCAL_GATEWAY_PING_TEST`: Set to `True` to run a ping test from your computer to the gateway.
6974

75+
### Anomaly Highlighting & Thresholds
76+
The console can color-highlight anomalous results to make issues obvious at a glance. You can toggle highlighting and configure thresholds in `config.py`:
77+
78+
- Enable/disable highlighting.
79+
- Thresholds for packet loss, latency, and jitter.
80+
- Thresholds for download/upload speeds.
81+
- Bufferbloat detection: compares latency under load to idle latency using a configurable delta.
82+
83+
Adjust these settings to match your network expectations and noise tolerance.
84+
7085
### Important: Handling the Device Access Code
7186
The gateway speed test requires your gateway's **Device Access Code** to log in. To store this securely, the script uses an environment variable.
7287

config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# Set to True to run the browser in headless mode (no visible UI).
1111
HEADLESS_MODE: bool = True
1212
# Set to True to enable verbose, high-resolution debug logging for troubleshooting.
13-
ENABLE_DEBUG_LOGGING: bool = True
13+
ENABLE_DEBUG_LOGGING: bool = False
1414

1515
# --- Gateway Configuration ---
1616
# The base URL for your AT&T gateway.

0 commit comments

Comments
 (0)