Internet Speed Logger

An application to track your internet download and upload speeds with an elegant web interface.

This is a time series based application which continuously monitors your internet connection and plots the results within a responsive web view along with providing basic aggregation of the current visible timeframe (mean). This leverages the official Speedtest.net CLI binary from Ookla to provide the best performance possible.

An early version of this service has been running for many years (~2016) and it has been instrumental for tracking internet performance issues.

Components

The requrements for Internet Speed Logger are:

• Node.js >= v12.0.0
• MongoDB

There are three core components to running Internet Speed Logger:

• Webserver (index.js) - Webserver which delivers static assets and provides API.
• Speedrunner (run-speedtest.js) - Daemon or One Shot process which performs the internet speed test.
• MongoDB - "Web Scale" persistence layer. 😜

The Webserver and MongoDB must always be running, however the Speedrunner can be either run as a daemon ./run-speedtest.js daemon or invoked via a schedule as a oneshot process ./run-speedtest.js. Both the Webserver and Speedrunner share the common config within config/default.json.

Configuration

Configuration for the logger & runner is in the config/default.js file. The following options are available:

Leaf	Default	Description
webserver.listenPort	3000	Port which the webserver will listen on
webserver.listenHost	0.0.0.0	Host which the webserver will listen on
db.connectionString	mongodb://speedtest:speedtest@mongo:27017/speedtest	Connection string the connection for the backend MongoDB compliant database. See: Connection String URI Format
db.collection	speedtest	Collection to use within MongoDB compliant database.
speedtest.commandString	bin/speedtest -f json --accept-license	Raw command to execute to perform speed test. Change this if you want it on a different path or specify a specific server.
speedtest.intervalSec	43200	Interval for which the speedtest will be run. This will be randomly skewed +/- 25% and limited to no less than 1800 (30 minutes) seconds between runs.

MongoDB bootstraps itself from the docker-entrypoint-initdb.d/mongo-init.js file. Meaningful options to change, which should correspond to what you set in config/default.json for the Node.js app:

Key	Default	Description
user	speedtest	The user that is created in for access to the speedtest DB
pwd	speedtest	Password for the specified user for access to the speedtest DB.

The db.connectionString in config/default.js should use the user & pwd you set in docker-entrypoint-initdb.d/mongo-init.js, like so:

"connectionString": "mongodb://<user>:<pwd>@mongo/speedtest",

Running Internet Speed Logger

Container

The images are published to GitHub Packages, and it contains both the webserver and test daemon.

git clone https://github.com/jeffbyrnes/internet-speed-logger.git
cd internet-speed-logger
docker compose up

The provided docker-compose.yml can be modified to suit, or used as an example for your own Docker Compose setup with other services.

You may see some errors upon boot:

speedlogger-web_1     | MongoNetworkError: failed to connect to server

these are normal as the web service will attempt to create the connection pool before MongoDB is ready. Once MongoDB is ready (~30s), all will work correctly.

Using Forever to run locally

Install the following:

• Node.js
• MongoDB

git clone https://github.com/jeffbyrnes/internet-speed-logger.git
cd internet-speed-logger
# download latest version of Speedtest-CLI binary to `bin` dir within repo >>
npm ci
npm run webserver-daemon
npm run speedtest-daemon

Updating

To get the latest Docker image, run:

docker compose stop
docker compose pull
docker compose up