Skip to content

Install a verified Ookla CLI for adaptive SQM #1093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jason-Morcos wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Install a verified Ookla CLI for adaptive SQM #1093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6bee45f
Firmware Rollout: the Autopilot hold note no longer tells you to save…
tvancott42 Sep 7, 2026
7b2aaaa
Monitoring - Live View: Bandwidth Hogs no longer lands twice after a …
tvancott42 Sep 7, 2026
c96a506
Monitoring - Live View: Bandwidth Hogs answers a scrub seconds sooner
tvancott42 Sep 7, 2026
3618244
Perf tweaks: raise the UCG firmware ceiling to UniFi OS 6.0.7
tvancott42 Sep 7, 2026
6f400e1
Make managed speedtest bootstrap non-blocking
Jason-Morcos Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 121 additions & 14 deletions src/NetworkOptimizer.Sqm/ScriptGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ namespace NetworkOptimizer.Sqm;
/// </summary>
public class ScriptGenerator
{
public const string ManagedSpeedtestPath = "/data/network-optimizer/bin/speedtest";
public const string ManagedSpeedtestArchiveRelease = "1.2.0";
public const string ManagedSpeedtestCliVersion = "1.2.0.84";
public const string ManagedSpeedtestBuildId = "ea6b6773cf";
public const string ManagedSpeedtestAarch64ArchiveSha256 = "3953d231da3783e2bf8904b6dd72767c5c6e533e163d3742fd0437affa431bd3";
public const string ManagedSpeedtestAarch64BinarySha256 = "d99fa13293f658b53eaa79fe81f4b210db39fdfc1e9698f33da3f234a6008df7";
public const string ManagedSpeedtestArmhfArchiveSha256 = "e45fcdebbd8a185553535533dd032d6b10bc8c64eee4139b1147b9c09835d08d";
public const string ManagedSpeedtestArmhfBinarySha256 = "66ad57568664e6f8580e14ad67316a57038fd22b30548bef98531df4ebcc8956";
public const string ManagedSpeedtestX86_64ArchiveSha256 = "5690596c54ff9bed63fa3732f818a05dbc2db19ad36ed68f21ca5f64d5cfeeb7";
public const string ManagedSpeedtestX86_64BinarySha256 = "31f1124c5ab8acdae6b9fe1741e704df420f9f2e7d429679fabe62075453c051";

private readonly SqmConfiguration _config;
private readonly string _name; // Normalized name for files (e.g., "wan1", "wan2")
private readonly int _initialDelaySeconds; // Delay before first speedtest (for staggering multiple WANs)
Expand Down Expand Up @@ -75,6 +86,15 @@ public string GenerateBootScript(Dictionary<string, string> baseline)
sb.AppendLine("PING_SCRIPT=\"$SQM_DIR/${SQM_NAME}-ping.sh\"");
sb.AppendLine("RESULT_FILE=\"$SQM_DIR/${SQM_NAME}-result.txt\"");
sb.AppendLine("LOG_FILE=\"/var/log/sqm-${SQM_NAME}.log\"");
sb.AppendLine($"SPEEDTEST_BIN=\"{ManagedSpeedtestPath}\"");
sb.AppendLine($"SPEEDTEST_RELEASE=\"{ManagedSpeedtestArchiveRelease}\"");
sb.AppendLine($"SPEEDTEST_CLI_VERSION=\"{ManagedSpeedtestCliVersion}\"");
sb.AppendLine($"SPEEDTEST_BUILD_ID=\"{ManagedSpeedtestBuildId}\"");
sb.AppendLine();
sb.AppendLine("log_speedtest_install_error() {");
sb.AppendLine(" echo \"[$(date)] ERROR: $*\" >> \"$LOG_FILE\"");
sb.AppendLine(" echo \"ERROR: $*\" >&2");
sb.AppendLine("}");
sb.AppendLine();
// Rotate log on boot/deploy: keep last 2000 lines (~1.5 days at 1 min ping interval)
sb.AppendLine("# Rotate log to prevent unbounded growth");
Expand All @@ -90,19 +110,94 @@ public string GenerateBootScript(Dictionary<string, string> baseline)
sb.AppendLine("# Section 1: Install Dependencies");
sb.AppendLine("# ============================================");
sb.AppendLine();
sb.AppendLine("# Install official Ookla speedtest if not present");
sb.AppendLine("if ! which speedtest > /dev/null 2>&1; then");
sb.AppendLine(" echo \"Installing Ookla speedtest...\" >> $LOG_FILE");
sb.AppendLine(" # Remove UniFi's speedtest if present");
sb.AppendLine(" apt-get remove -y speedtest 2>/dev/null || true");
sb.AppendLine(" # Install official Speedtest by Ookla");
sb.AppendLine(" curl -s https://packagecloud.io/install/repositories/ookla/speedtest-cli/script.deb.sh | bash");
sb.AppendLine(" apt-get install -y speedtest");
sb.AppendLine("case \"$(uname -m)\" in");
sb.AppendLine(" aarch64|arm64)");
sb.AppendLine(" SPEEDTEST_ARCH=\"aarch64\"");
sb.AppendLine($" SPEEDTEST_ARCHIVE_SHA256=\"{ManagedSpeedtestAarch64ArchiveSha256}\"");
sb.AppendLine($" SPEEDTEST_BINARY_SHA256=\"{ManagedSpeedtestAarch64BinarySha256}\"");
sb.AppendLine(" ;;");
sb.AppendLine(" armv7l|armv7)");
sb.AppendLine(" SPEEDTEST_ARCH=\"armhf\"");
sb.AppendLine($" SPEEDTEST_ARCHIVE_SHA256=\"{ManagedSpeedtestArmhfArchiveSha256}\"");
sb.AppendLine($" SPEEDTEST_BINARY_SHA256=\"{ManagedSpeedtestArmhfBinarySha256}\"");
sb.AppendLine(" ;;");
sb.AppendLine(" x86_64|amd64)");
sb.AppendLine(" SPEEDTEST_ARCH=\"x86_64\"");
sb.AppendLine($" SPEEDTEST_ARCHIVE_SHA256=\"{ManagedSpeedtestX86_64ArchiveSha256}\"");
sb.AppendLine($" SPEEDTEST_BINARY_SHA256=\"{ManagedSpeedtestX86_64BinarySha256}\"");
sb.AppendLine(" ;;");
sb.AppendLine(" *)");
sb.AppendLine(" SPEEDTEST_ARCH=\"unsupported\"");
sb.AppendLine(" SPEEDTEST_ARCHIVE_SHA256=\"unsupported\"");
sb.AppendLine(" SPEEDTEST_BINARY_SHA256=\"unsupported\"");
sb.AppendLine(" ;;");
sb.AppendLine("esac");
sb.AppendLine("SPEEDTEST_URL=\"https://install.speedtest.net/app/cli/ookla-speedtest-${SPEEDTEST_RELEASE}-linux-${SPEEDTEST_ARCH}.tgz\"");
sb.AppendLine();
sb.AppendLine("speedtest_is_valid() {");
sb.AppendLine(" [ \"$SPEEDTEST_BINARY_SHA256\" != \"unsupported\" ] && command -v sha256sum >/dev/null 2>&1 \\");
sb.AppendLine(" && [ -f \"$SPEEDTEST_BIN\" ] && [ ! -L \"$SPEEDTEST_BIN\" ] && [ -x \"$SPEEDTEST_BIN\" ] \\");
sb.AppendLine(" && printf '%s %s\\n' \"$SPEEDTEST_BINARY_SHA256\" \"$SPEEDTEST_BIN\" | sha256sum -c - >/dev/null 2>&1 \\");
sb.AppendLine(" && \"$SPEEDTEST_BIN\" --version 2>/dev/null | head -n 1 | grep -Fq \"Speedtest by Ookla ${SPEEDTEST_CLI_VERSION} (${SPEEDTEST_BUILD_ID})\"");
sb.AppendLine("}");
sb.AppendLine();
sb.AppendLine("install_managed_speedtest() (");
sb.AppendLine(" for required_command in curl tar sha256sum; do");
sb.AppendLine(" if ! command -v \"$required_command\" >/dev/null 2>&1; then");
sb.AppendLine(" log_speedtest_install_error \"required command not found: $required_command\"");
sb.AppendLine(" return 1");
sb.AppendLine(" fi");
sb.AppendLine(" done");
sb.AppendLine(" if [ \"$SPEEDTEST_ARCH\" = \"unsupported\" ]; then");
sb.AppendLine(" log_speedtest_install_error \"unsupported gateway architecture: $(uname -m)\"");
sb.AppendLine(" return 1");
sb.AppendLine(" fi");
sb.AppendLine(" SPEEDTEST_DIR=$(dirname \"$SPEEDTEST_BIN\")");
sb.AppendLine(" if ! mkdir -p \"$SPEEDTEST_DIR\"; then");
sb.AppendLine(" log_speedtest_install_error \"could not create speedtest directory\"");
sb.AppendLine(" return 1");
sb.AppendLine(" fi");
sb.AppendLine(" SPEEDTEST_STAGE=$(mktemp -d \"${SPEEDTEST_DIR}/.speedtest-install.XXXXXX\") || {");
sb.AppendLine(" log_speedtest_install_error \"could not create speedtest staging directory\"");
sb.AppendLine(" return 1");
sb.AppendLine(" }");
sb.AppendLine(" cleanup_speedtest_stage() {");
sb.AppendLine(" rm -rf \"$SPEEDTEST_STAGE\"");
sb.AppendLine(" rm -f \"${SPEEDTEST_BIN}.new\"");
sb.AppendLine(" }");
sb.AppendLine(" trap cleanup_speedtest_stage EXIT");
sb.AppendLine(" trap 'exit 1' HUP INT TERM");
sb.AppendLine(" curl --fail --silent --show-error --location --proto '=https' --max-time 120 --max-filesize 4194304 \"$SPEEDTEST_URL\" -o \"$SPEEDTEST_STAGE/speedtest.tgz\" \\");
sb.AppendLine(" || { log_speedtest_install_error \"failed to download Ookla speedtest\"; return 1; }");
sb.AppendLine(" printf '%s %s\\n' \"$SPEEDTEST_ARCHIVE_SHA256\" \"$SPEEDTEST_STAGE/speedtest.tgz\" | sha256sum -c - >/dev/null 2>&1 \\");
sb.AppendLine(" || { log_speedtest_install_error \"Ookla speedtest archive checksum mismatch\"; return 1; }");
sb.AppendLine(" tar -xzf \"$SPEEDTEST_STAGE/speedtest.tgz\" -C \"$SPEEDTEST_STAGE\" speedtest \\");
sb.AppendLine(" || { log_speedtest_install_error \"failed to extract Ookla speedtest\"; return 1; }");
sb.AppendLine(" [ -f \"$SPEEDTEST_STAGE/speedtest\" ] && [ ! -L \"$SPEEDTEST_STAGE/speedtest\" ] \\");
sb.AppendLine(" || { log_speedtest_install_error \"Ookla speedtest archive did not contain a regular binary\"; return 1; }");
sb.AppendLine(" chmod 0755 \"$SPEEDTEST_STAGE/speedtest\" \\");
sb.AppendLine(" || { log_speedtest_install_error \"could not make Ookla speedtest executable\"; return 1; }");
sb.AppendLine(" printf '%s %s\\n' \"$SPEEDTEST_BINARY_SHA256\" \"$SPEEDTEST_STAGE/speedtest\" | sha256sum -c - >/dev/null 2>&1 \\");
sb.AppendLine(" || { log_speedtest_install_error \"Ookla speedtest binary checksum mismatch\"; return 1; }");
sb.AppendLine(" mv -f \"$SPEEDTEST_STAGE/speedtest\" \"${SPEEDTEST_BIN}.new\" \\");
sb.AppendLine(" || { log_speedtest_install_error \"could not stage Ookla speedtest\"; return 1; }");
sb.AppendLine(" mv -f \"${SPEEDTEST_BIN}.new\" \"$SPEEDTEST_BIN\" \\");
sb.AppendLine(" || { log_speedtest_install_error \"could not activate Ookla speedtest\"; return 1; }");
sb.AppendLine(" speedtest_is_valid \\");
sb.AppendLine(" || { log_speedtest_install_error \"installed Ookla speedtest failed validation\"; return 1; }");
sb.AppendLine(")");
sb.AppendLine();
sb.AppendLine("# A missing calibration CLI should not prevent the SQM scripts and cron entries from deploying.");
sb.AppendLine("if ! speedtest_is_valid; then");
sb.AppendLine(" echo \"[$(date)] Installing Ookla speedtest ${SPEEDTEST_CLI_VERSION}...\" >> \"$LOG_FILE\"");
sb.AppendLine(" if ! install_managed_speedtest; then");
sb.AppendLine(" echo \"[$(date)] WARNING: Ookla speedtest installation failed; continuing without adaptive calibration\" >> \"$LOG_FILE\"");
sb.AppendLine(" echo \"WARNING: Ookla speedtest installation failed; continuing without adaptive calibration\" >&2");
sb.AppendLine(" fi");
sb.AppendLine("fi");
sb.AppendLine();
// Refresh the package index once if either base dependency is missing, so a
// console with stale/empty apt lists can still resolve bc/jq. The Ookla block
// above gets its index refresh from the packagecloud script; these don't.
// console with stale/empty apt lists can still resolve bc/jq.
sb.AppendLine("# Refresh package lists once if a base dependency is missing");
sb.AppendLine("if ! which bc > /dev/null 2>&1 || ! which jq > /dev/null 2>&1; then");
sb.AppendLine(" apt-get update");
Expand Down Expand Up @@ -253,6 +348,15 @@ private string GenerateSpeedtestScript(Dictionary<string, string> baseline)
sb.AppendLine($"LINK_SPEED_HEADROOM=\"0.98\"");
sb.AppendLine($"RESULT_FILE=\"/data/sqm/{_name}-result.txt\"");
sb.AppendLine($"LOG_FILE=\"/var/log/sqm-{_name}.log\"");
sb.AppendLine($"SPEEDTEST_BIN=\"{ManagedSpeedtestPath}\"");
sb.AppendLine($"SPEEDTEST_CLI_VERSION=\"{ManagedSpeedtestCliVersion}\"");
sb.AppendLine($"SPEEDTEST_BUILD_ID=\"{ManagedSpeedtestBuildId}\"");
sb.AppendLine("case \"$(uname -m)\" in");
sb.AppendLine($" aarch64|arm64) SPEEDTEST_BINARY_SHA256=\"{ManagedSpeedtestAarch64BinarySha256}\" ;;");
sb.AppendLine($" armv7l|armv7) SPEEDTEST_BINARY_SHA256=\"{ManagedSpeedtestArmhfBinarySha256}\" ;;");
sb.AppendLine($" x86_64|amd64) SPEEDTEST_BINARY_SHA256=\"{ManagedSpeedtestX86_64BinarySha256}\" ;;");
sb.AppendLine(" *) SPEEDTEST_BINARY_SHA256=\"unsupported\" ;;");
sb.AppendLine("esac");
sb.AppendLine();

// Baseline data
Expand All @@ -265,9 +369,12 @@ private string GenerateSpeedtestScript(Dictionary<string, string> baseline)
sb.AppendLine();

// Check for speedtest
sb.AppendLine("# Check if speedtest is installed");
sb.AppendLine("if ! which speedtest > /dev/null 2>&1; then");
sb.AppendLine(" echo \"[$(date)] ERROR: speedtest not found\" >> $LOG_FILE");
sb.AppendLine("# Validate the exact managed speedtest build before changing TC rates");
sb.AppendLine("if [ \"$SPEEDTEST_BINARY_SHA256\" = \"unsupported\" ] \\");
sb.AppendLine(" || [ ! -f \"$SPEEDTEST_BIN\" ] || [ -L \"$SPEEDTEST_BIN\" ] || [ ! -x \"$SPEEDTEST_BIN\" ] \\");
sb.AppendLine(" || ! printf '%s %s\\n' \"$SPEEDTEST_BINARY_SHA256\" \"$SPEEDTEST_BIN\" | sha256sum -c - >/dev/null 2>&1 \\");
sb.AppendLine(" || ! \"$SPEEDTEST_BIN\" --version 2>/dev/null | head -n 1 | grep -Fq \"Speedtest by Ookla ${SPEEDTEST_CLI_VERSION} (${SPEEDTEST_BUILD_ID})\"; then");
sb.AppendLine(" echo \"[$(date)] ERROR: managed speedtest binary is missing or failed validation\" >> $LOG_FILE");
sb.AppendLine(" exit 1");
sb.AppendLine("fi");
sb.AppendLine();
Expand Down Expand Up @@ -306,7 +413,7 @@ private string GenerateSpeedtestScript(Dictionary<string, string> baseline)
? ""
: $" --server-id={_config.PreferredSpeedtestServerId}";
sb.AppendLine("# Run speedtest");
sb.AppendLine($"speedtest_output=$(speedtest --accept-license --accept-gdpr --format=json --interface=$INTERFACE{serverIdArg})");
sb.AppendLine($"speedtest_output=$(\"$SPEEDTEST_BIN\" --accept-license --accept-gdpr --format=json --interface=$INTERFACE{serverIdArg})");
sb.AppendLine();
sb.AppendLine("# Parse download speed (bytes/sec to Mbps)");
sb.AppendLine("download_speed_bytes=$(echo \"$speedtest_output\" | jq .download.bandwidth)");
Expand Down
14 changes: 13 additions & 1 deletion src/NetworkOptimizer.Web/Components/Pages/Monitoring.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2659,6 +2659,10 @@
private DotNetObjectReference<Monitoring>? _mapDotNetRef;
private DateTime? _mapHistoricAt;
private HistoricStatSnapshot? _historicSnapshot;
// Seeks overlap during a drag, and a slow older query must not land over a newer answer.
private int _historicSnapshotSeq;
// The instant the landed snapshot's WAN rate describes; Bandwidth Hogs asks once it matches the playhead.
private DateTime? _hogsWanRateAt;

// Setup is the default so a site that cannot finish initializing - unreachable InfluxDB,
// failing SNMP - still lands where it can be fixed. It just must not RENDER before the
Expand Down Expand Up @@ -4435,6 +4439,8 @@
ClearLinkedInstant();
_mapHistoricAt = null;
_historicSnapshot = null;
_hogsWanRateAt = null;
Interlocked.Increment(ref _historicSnapshotSeq);
await InvokeAsync(StateHasChanged);
return;
}
Expand Down Expand Up @@ -4516,6 +4522,7 @@

private async Task FetchHistoricSnapshotAsync(DateTime at)
{
var seq = Interlocked.Increment(ref _historicSnapshotSeq);
var from = at.AddSeconds(-90);
var to = at.AddSeconds(30);

Expand Down Expand Up @@ -4727,6 +4734,9 @@
? await BuildPerWanLatencyAsync(from, to, at)
: new Dictionary<string, WanLatencySnapshot>();

// A newer seek (or a return to live) has superseded this instant.
if (seq != _historicSnapshotSeq) return;
_hogsWanRateAt = at;
_historicSnapshot = new HistoricStatSnapshot
{
PerWan = perWan,
Expand Down Expand Up @@ -4997,7 +5007,7 @@
private RenderFragment BandwidthHogs => __builder =>
{
var wanRates = GetWanRates();
<BandwidthHogsCard HistoricAt="_mapHistoricAt" Paused="_mapPaused"
<BandwidthHogsCard HistoricAt="_mapHistoricAt" Paused="_mapPaused" WanRateAt="_hogsWanRateAt"
WanDownBps="wanRates.download" WanUpBps="wanRates.upload"
WanKeys="LiveWan.SelectedKeys" WanHistoryKeys="GetWanHistoryKeys()"
MultiWan="_multiWanUiVisible" />
Expand Down Expand Up @@ -5701,6 +5711,8 @@
_mapMounted = false;
_mapHistoricAt = null;
_historicSnapshot = null;
_hogsWanRateAt = null;
Interlocked.Increment(ref _historicSnapshotSeq);
try { await JS.InvokeVoidAsync("eval", "window.__lanFlowMap?.unmount();"); }
catch { }
}
Expand Down
Loading