Skip to main content

Automates major speed test sites with a web browser for continuous network quality monitoring

Reason this release was yanked:

Use >= 0.4.4

Project description

speedtest-z

PyPI version CI Python

日本語版 / Japanese

speedtest-z automates major speed test sites with a web browser, capturing real user-experience network quality for continuous monitoring.

  • Supports 8 speed test sites (Cloudflare, Netflix, Ookla, M-Lab, and more)
  • Zabbix integration for continuous network quality monitoring
  • Quick start: pip install speedtest-z

Demo - 8 speed test sites

Features

  • Runs speed tests on 8 different sites automatically (Cloudflare, Netflix/fast.com, Google Fiber, Ookla, Box-test, M-Lab, USEN, iNonius)
  • Sends results to Zabbix via trapper items (using zappix)
  • Configurable test frequency per site (probability-based throttling)
  • Screenshot capture for debugging
  • Headless or GUI Chrome mode
  • CLI with --dry-run, site selection, etc.
  • systemd timer integration for scheduled execution

Table of Contents

Prerequisites

  • Python >= 3.10
  • Google Chrome browser (not installable via pip -- must be installed separately)

Installation

pip install speedtest-z

Development Setup

git clone https://github.com/shigechika/speedtest-z.git
cd speedtest-z
python3 -m venv .venv
. .venv/bin/activate
pip install -e .

Dependencies

Tab Completion (optional)

pip install speedtest-z[completion]
eval "$(register-python-argcomplete speedtest-z)"

Add the eval line to your shell profile (~/.bashrc or ~/.zshrc) to enable it permanently.

Configuration

config.ini

The configuration file is searched in the following order (-c / --config can override):

  1. ./config.ini in the current directory
  2. ~/.config/speedtest-z/config.ini (XDG_CONFIG_HOME)

Copy config.ini-sample to one of these locations and edit as needed.

Sections

[general]
# Execution mode
dryrun = true          # true = do not send data to Zabbix
headless = true        # true = run Chrome in headless mode
timeout = 30           # timeout in seconds for each test
# ookla_server = IPA CyberLab   # Ookla test server (omit for auto-select)

[zabbix]
# Zabbix server settings
server = 127.0.0.1
port = 10051
host = speedtest-agent   # Zabbix host name for trapper items

[snapshot]
# Screenshot capture settings
enable = true
save_dir = ./snapshots

[frequency]
# Execution probability per site (0-100)
# 100 = always run, 50 = ~50% chance, 0 = disabled
cloudflare = 100
netflix = 100
google = 100
ookla = 50
boxtest = 50
mlab = 10
usen = 50
inonius = 50

logging.ini

An optional logging.ini file can be used to customize log output. The file is searched in the same order as config.ini:

  1. ./logging.ini in the current directory
  2. ~/.config/speedtest-z/logging.ini (XDG_CONFIG_HOME)

If neither is found, the default logging configuration (INFO level to stdout) is used.

Usage

speedtest-z [options] [site ...]

Options

Option Description
-V, --version Show program version and exit
-c, --config CONFIG Config file path (default: ./config.ini or ~/.config/speedtest-z/config.ini)
-n, --dry-run Test run (do not send data to Zabbix)
--headless Run Chrome in headless mode
--no-headless, --headed Run Chrome with GUI (non-headless)
--timeout SECONDS Timeout in seconds for each test
--list-sites List available test sites and exit
-y, --yes Skip confirmation prompt
-d, --debug Enable debug output
site Positional argument(s): test site(s) to run (default: all)

Confirmation Prompt

When run from an interactive terminal (TTY), speedtest-z asks for confirmation before connecting to test sites. Use -y to skip this prompt, or pipe input to suppress it automatically (e.g., cron, systemd).

$ speedtest-z -n
speedtest-z: connecting to 8 site(s) (cloudflare, netflix, ...)
Continue? [y/N]: y

Examples

# Run all test sites (dry-run)
speedtest-z -n

# Run specific sites
speedtest-z cloudflare netflix

# Run with GUI browser for debugging
speedtest-z --no-headless -d cloudflare

# List available sites
speedtest-z --list-sites

Example Output

Measured at JANOG57 Meeting (Feb 2026, Osaka):

$ speedtest-z --dry-run
2026-02-13 09:39:27 [INFO] speedtest-z: START
2026-02-13 09:39:27 [INFO] Config loaded: config.ini
2026-02-13 09:39:27 [INFO] Initializing Chrome WebDriver...
2026-02-13 09:39:28 [INFO] cloudflare: OPEN
2026-02-13 09:39:35 [INFO] cloudflare: Test started
2026-02-13 09:40:24 [INFO] cloudflare: COMPLETED (Quality Scores appeared)
2026-02-13 09:40:27 [INFO] Dryrun: True - Data not sent.
2026-02-13 09:40:27 [INFO] netflix: OPEN
2026-02-13 09:40:53 [INFO] netflix: COMPLETED (succeeded class detected)
2026-02-13 09:40:53 [INFO] google: OPEN
2026-02-13 09:41:20 [INFO] google: COMPLETED
2026-02-13 09:41:20 [INFO] ookla: OPEN (Attempt 1/3)
2026-02-13 09:42:00 [INFO] ookla: COMPLETED
2026-02-13 09:42:02 [INFO] boxtest: OPEN
2026-02-13 09:43:17 [INFO] boxtest: COMPLETED
2026-02-13 09:43:17 [INFO] mlab: OPEN
2026-02-13 09:44:05 [INFO] mlab: COMPLETED
2026-02-13 09:44:05 [INFO] usen: OPEN
2026-02-13 09:44:34 [INFO] usen: COMPLETED (speedtest_wait class removed)
2026-02-13 09:44:34 [INFO] inonius: OPEN
2026-02-13 09:45:31 [INFO] inonius: COMPLETED
2026-02-13 09:45:31 [INFO] speedtest-z: FINISH

All 8 sites completed in about 6 minutes.

Supported Test Sites

Site URL Metrics (Zabbix keys)
cloudflare https://speed.cloudflare.com/ download, upload, latency, jitter
netflix https://fast.com/ download, upload, latency, server-locations
google https://speed.googlefiber.net/ download, upload, ping
ookla https://www.speedtest.net/ download, upload, ping
boxtest https://www.box-test.com/ POP, DownloadSpeed, DownloadDuration, DownloadRTT, UploadSpeed, UploadDuration, UploadRTT, latency
mlab https://speed.measurementlab.net/ download, upload, latency, retrans
usen https://speedtest.gate02.ne.jp/ download, upload, ping, jitter
inonius https://inonius.net/speedtest/ IPv4/IPv6: DL, UL, RTT, JIT, MSS

All Zabbix item keys are prefixed with the site name (e.g., cloudflare.download, usen.ping, inonius.IPv4_DL).

Zabbix Integration

  1. Import the speedtest-z_templates.yaml template into Zabbix.
  2. All items are trapper type -- the agent pushes data to Zabbix using the zappix sender protocol.
  3. Set the [zabbix] section in config.ini to match your Zabbix server settings.
  4. The host value in config.ini must match the host name registered in Zabbix.

Deployment (systemd)

The deploy/ directory contains systemd unit files for scheduled execution:

File Description
speedtest-z.service Service unit (runs speedtest-z from the venv)
speedtest-z.timer Timer unit (runs every 6 minutes)
SeleniumCleaner.cron Cron job to clean up stale Chrome temp files

Setup

# Copy unit files
cp deploy/speedtest-z.service ~/.config/systemd/user/
cp deploy/speedtest-z.timer ~/.config/systemd/user/

# Reload and enable
systemctl --user daemon-reload
systemctl --user enable --now speedtest-z.timer

# Check status
systemctl --user status speedtest-z.timer
systemctl --user list-timers

Optionally, install the cron job for cleaning up stale Chrome temporary directories:

sudo cp deploy/SeleniumCleaner.cron /etc/cron.d/SeleniumCleaner

Share Your Results!

Got the fastest or slowest speed test result? We'd love to see it!

Submit your results via GitHub Issues with:

  • Screenshot(s) from the snapshots/ directory
  • CLI log output (speedtest-z --dry-run)

Whether it's blazing fast datacenter fiber or painfully slow hotel Wi-Fi, all results are welcome.

License

Apache License 2.0

Copyright 2026 AIKAWA Shigechika

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

speedtest_z-0.4.2.tar.gz (346.1 kB view details)

Uploaded Source

Built Distribution

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

speedtest_z-0.4.2-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file speedtest_z-0.4.2.tar.gz.

File metadata

  • Download URL: speedtest_z-0.4.2.tar.gz
  • Upload date:
  • Size: 346.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for speedtest_z-0.4.2.tar.gz
Algorithm Hash digest
SHA256 f5e9f85a118184d8ebbd54bf6cce173ecdf137d5420a7e0ec8f550c2e705221e
MD5 b3a989236ddd9fcf204f79d0cd1dfe9a
BLAKE2b-256 7febdb79d4f53bb8288308d8a6b4226a96be098699c16568385e97ca59ba3352

See more details on using hashes here.

Provenance

The following attestation bundles were made for speedtest_z-0.4.2.tar.gz:

Publisher: release.yml on shigechika/speedtest-z

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file speedtest_z-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: speedtest_z-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for speedtest_z-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 87cb0447a54601fe021a7785921ac1785a164255c8f783ba2dd87e7a69cd310f
MD5 2db52202a030b34b8a19ee50228b16c9
BLAKE2b-256 fe645d8841bb98094e5c6b579d824b0a02cda8b43b23a9a1f8989ee23fe0af70

See more details on using hashes here.

Provenance

The following attestation bundles were made for speedtest_z-0.4.2-py3-none-any.whl:

Publisher: release.yml on shigechika/speedtest-z

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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