Automatically capture your Ookla Speedtest metrics and display them in a Grafana dashboard

Last update: Feb 22, 2022

Overview

Speedtest All-In-One

Automatically capture your Ookla Speedtest metrics and display them in a Grafana dashboard.

Getting Started

About This Code

This script was written to track internet speed using Ookla's speed test.

This repository contains everything necessary to build your own Speedtest dashboard (Python script, SQLite database, Grafana dashboard).

Total application size is less than 450MB! ~276MB for Grafana; ~153MB for Python/SQLite

Dashboard and Database data is persistent through the use of Docker Volumes.

Prerequisites

Docker Engine
Docker host must be able to access Docker Hub

Python Libraries

See pyproject.toml

Instructions For Use

Clone this repository.
Modify the speedtest_aio-cron file to adjust your test interval. The default is 15 minutes. Visit crontab.guru for an example on cron scheduling syntax.
Modify the Test Results panel in Grafana to match the values for your Internet connection. The default is set to 75Mb/s down and 25Mb/s up (which happen to be my Internet speed). Edit the Test Results panel, goto the Overrides and change the Max values for all Overrides to fit your situation. (This will change the gradient levels for download_throughput, upload_throughput and ping_latency.)

Docker Commands

To pull/build the necessary Docker images: docker-compose build
To run the application: docker-compose up -d
To stop the application: docker-compose down

Grafana

Default username/password is admin/admin.
You will be prompted to change your password upon first login.
Access your Grafana dashboard via http://localhost:3000 OR replace localhost with the IP Address of the host.
WARNING This dashboard will be accessible to all hosts in the same subnet!

Acknowledgements

Grafana dashboard layout borrowed from speedtest_exporter.

Authors

Aaron Melton - Author - Aaron Melton [email protected]

You might also like...

Lima is an alternative to using Docker Desktop on your Mac.

lima-xbar-plugin Table of Contents Description Installation Dependencies Lima is an alternative to using Docker Desktop on your Mac. Description This

68 Dec 22, 2022

A tool to convert AWS EC2 instances back and forth between On-Demand and Spot billing models.

ec2-spot-converter This tool converts existing AWS EC2 instances back and forth between On-Demand and 'persistent' Spot billing models while preservin

152 Dec 29, 2022

Iris is a highly configurable and flexible service for paging and messaging.

Iris Iris core, API, UI and sender service. For third-party integration support, see iris-relay, a stateless proxy designed to sit at the edge of a pr

715 Dec 28, 2022

StackStorm (aka "IFTTT for Ops") is event-driven automation for auto-remediation, security responses, troubleshooting, deployments, and more. Includes rules engine, workflow, 160 integration packs with 6000+ actions (see https://exchange.stackstorm.org) and ChatOps. Installer at https://docs.stackstorm.com/install/index.html. Questions? https://forum.stackstorm.com/.

StackStorm is a platform for integration and automation across services and tools, taking actions in response to events. Learn more at www.stackstorm.

5.3k Jan 2, 2023

pyinfra automates infrastructure super fast at massive scale. It can be used for ad-hoc command execution, service deployment, configuration management and more.

pyinfra automates/provisions/manages/deploys infrastructure super fast at massive scale. It can be used for ad-hoc command execution, service deployme

2.1k Dec 29, 2022

Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:

Latest Salt Documentation Open an issue (bug report, feature request, etc.) Salt is the world’s fastest, most intelligent and scalable automation engi

12.9k Jan 4, 2023

Simple, Pythonic remote execution and deployment.

Welcome to Fabric! Fabric is a high level Python (2.7, 3.4+) library designed to execute shell commands remotely over SSH, yielding useful Python obje

13.8k Jan 6, 2023

Cross-platform lib for process and system monitoring in Python

Home Install Documentation Download Forum Blog Funding What's new Summary psutil (process and system utilities) is a cross-platform library for retrie

9k Jan 2, 2023

This repository contains code examples and documentation for learning how applications can be developed with Kubernetes

BigBitBus KAT Components Click on the diagram to enlarge, or follow this link for detailed documentation Introduction Welcome to the BigBitBus Kuberne

51 Oct 16, 2022

Comments

Default Dashboard Isn't Loading In Grafana

While testing a new Dockerfile for the speedtest based on the Alpine image I noticed the default dashboard isn't loading into the Grafana image. This was known to be working prior to v0.3.1 but neither change in v0.3.1 influenced the creation of the Grafana image so I'm uncertain what introduced this issue. Investigating...
bug

opened by aaronmelton 3
sqlite error
I tried to fugure this out by myself, but I'm unfortunately new to Docker and Grafan and am more used to Lua and C++ then Python :( When i try to run this as stated in another issue the Dashborad does not load completly, specifically it can't load data.

Going through the logs the speedtest_grafana container I was able to find what I think causes the problem:

logger=sqlstore t=2022-02-18T08:02:09.9+0000 lvl=info msg="Connecting to DB" dbtype=sqlite3

logger=migrator t=2022-02-18T08:02:09.91+0000 lvl=info msg="Starting DB migrations"

logger=migrator t=2022-02-18T08:02:09.92+0000 lvl=info msg="migrations completed" performed=0 skipped=381 duration=459.934µs

And a little later: 18T08:05:18.44+0000 lvl=eror msg="Could not execute query" err="unable to open database file: no such file or directory" query="SELECT\n timestamp AS \"time\",\n avg(download_bandwidth)\nFROM speedtest\nORDER BY timestamp"

Here are the complete logs I was looking at. The restart request for the plugin does not go away when: - restarting the speedtest_grafana container - restarting the speedtest_aio container - restarting speedtest_aio-master - Restarting docker and the docker engine - restarting the entire PC

Most other error before, such as Grafana not loading, Dashboard not accessible were able to be treated by restarting a view times (probably some kind of restart requirments for Plugins. as given on the very top of the first page)

Sadly the speedtest_aio container for me has no logged events what so ever, eventhough my guess after looking through the volume and checking the place the database is supposed to be stored the this container should have the sqlite file, but the var/lib//db directory where the database should be is empty.

I then ended up looking at the speedtest_aio.py file and realisedt, that non of the errors defined in there and related to the database where thrown.

Since I don't know python to well the only Ideas I have at this point are:

The file is never run thus not creating the database

On the webpage of sqlite it states to create a new file with squlite test.db however teting .sqlite was no problem during my testing.

I hope the data provided can help solving it (or you can tell me what I can do to fix it) :)
opened by NewtonsScan 12

Releases(v0.4.2)

v0.4.2(Feb 22, 2022)
This version is not backward-compatible with the volumes created by the v0.3 train!

[0.4.2] - 2022-02-22

Changed

README.md: Improved spacing for Docker commands.

Updating click (8.0.3 -> 8.0.4)

Updating gitpython (3.1.26 -> 3.1.27)

Updating platformdirs (2.4.1 -> 2.5.1)

Updating typing-extensions (4.0.1 -> 4.1.1)

[0.4.1] - 2022-02-22

Changed

Dockerfile-speedtest: Added prune label to the base image build.

grafana/grafana_dashboard.json: Sorting test list by descending time.

README.md: Improved instructions for Docker operation.

speedtest_monitor.png: New screenshot to reflect new layout.

[0.4.0] - 2022-02-21

Changed

docker-compose.yml: Updating paths to match changes in application.

Dockerfile-grafana: Added ownership flags to COPY command.

Dockerfile-speedtest-RPi: Replacing speedtest_aio-cron with crontab.

Dockerfile-speedtest: Updated for use in Alpine Linux.

grafana/datasource.yml: Updating paths to match changes in application.

grafana/grafana_dashboard.json: Updating to match changes to code.

README.md: Improved instructions for Docker operation.

speedtest_aio-cron: Updated for use in Alpine Linux.

speedtest_aio.py: create_database(): Removed fields that are no longer being tracked.

Source code(tar.gz)
Source code(zip)
v0.3.1(Feb 7, 2022)

Source code(tar.gz)
Source code(zip)

Owner

Aaron Melton

GitHub Repository

SSH tunnels to remote server.

Author: Pahaz Repo: https://github.com/pahaz/sshtunnel/ Inspired by https://github.com/jmagnusson/bgtunnel, which doesn't work on Windows. See also: h

1k Dec 28, 2022

Ajenti Core and stock plugins

Ajenti is a Linux & BSD modular server admin panel. Ajenti 2 provides a new interface and a better architecture, developed with Python3 and AngularJS.

7k Jan 03, 2023

Automate SSH in python easily!

RedExpect RedExpect makes automating remote machines over SSH very easy to do and is very fast in doing exactly what you ask of it. Based on ssh2-pyth

19 Dec 17, 2022

This project shows how to serve an TF based image classification model as a web service with TFServing, Docker, and Kubernetes(GKE).

Deploying ML models with CPU based TFServing, Docker, and Kubernetes By: Chansung Park and Sayak Paul This project shows how to serve a TensorFlow ima

104 Dec 28, 2022

SSH to WebSockets Bridge

wssh wssh is a SSH to WebSockets Bridge that lets you invoke a remote shell using nothing but HTTP. The client connecting to wssh doesn't need to spea

1.3k Dec 25, 2022

StackStorm (aka "IFTTT for Ops") is event-driven automation for auto-remediation, security responses, troubleshooting, deployments, and more. Includes rules engine, workflow, 160 integration packs with 6000+ actions (see https://exchange.stackstorm.org) and ChatOps. Installer at https://docs.stackstorm.com/install/index.html. Questions? https://forum.stackstorm.com/.

StackStorm is a platform for integration and automation across services and tools, taking actions in response to events. Learn more at www.stackstorm.

5.3k Jan 02, 2023

Automatically capture your Ookla Speedtest metrics and display them in a Grafana dashboard

Related tags

Overview

Speedtest All-In-One

Getting Started

About This Code

Prerequisites

Python Libraries

Instructions For Use

Docker Commands

Grafana

Acknowledgements

Authors

You might also like...

Lima is an alternative to using Docker Desktop on your Mac.

A tool to convert AWS EC2 instances back and forth between On-Demand and Spot billing models.

Iris is a highly configurable and flexible service for paging and messaging.

pyinfra automates infrastructure super fast at massive scale. It can be used for ad-hoc command execution, service deployment, configuration management and more.

Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:

Simple, Pythonic remote execution and deployment.

Cross-platform lib for process and system monitoring in Python

This repository contains code examples and documentation for learning how applications can be developed with Kubernetes

Comments

Default Dashboard Isn't Loading In Grafana

sqlite error

Releases(v0.4.2)

v0.4.2(Feb 22, 2022)

[0.4.2] - 2022-02-22

Changed

[0.4.1] - 2022-02-22

Changed

[0.4.0] - 2022-02-21

Changed

v0.3.1(Feb 7, 2022)

Owner

Aaron Melton

SSH tunnels to remote server.

Ajenti Core and stock plugins

Automate SSH in python easily!

This project shows how to serve an TF based image classification model as a web service with TFServing, Docker, and Kubernetes(GKE).

SSH to WebSockets Bridge

Visual disk-usage analyser for docker images

Remote Desktop Protocol in Twisted Python

A charmed operator for running PGbouncer on kubernetes.

A system for managing CI data for Mozilla projects

Tools and Docker images to make a fast Ruby on Rails development environment

Manage your SSH like a boss.

Get Response Of Container Deployment Kube with python

Ingress patch example by Kustomize

A cron monitoring tool written in Python & Django

A colony of interacting processes

Prometheus exporter for AWS Simple Queue Service (SQS)

a CLI that provides a generic automation layer for assessing the security of ML models

Chartreuse: Automated Alembic migrations within kubernetes

A collection of beginner-friendly DevOps content