internet-speedtest-docker
Spoiler Alert
This project won't help you with your connection, actually this project born when I need to monitoring the speed of my Internet, create a report to send to my ISP, so they can take some action. Using Docker Compose I put together three containers with the tools needed to monitoring and display the status of your Internet (and I know that tool can do more or can be better).
Here in Brazil is a mess to contract a good ISP, they just don't delivery the speed they should for the users. Generally in a small business or a residence you can't pay for a very expensive plans where they certify the bandwidth delivered. So you have to call them many times complaining about the speed of your internet connection and always they will ask you to do that Internet Tests Online, such as SpeedTest, AT&T SpeedTest, TestMyNet, most of this tests is based only on ICMP messages that don't reflect your real bandwidth on that time. Or even worse your ISP can allow all trafic ICMP so when you test appers that you have a good speed but when you have to download some content you can't do it that well. There are much more to talk about it but I don't wanna spend so much time talk about the things that are wrong here.
Running container
The only requirement to run this compose is have Docker Compose installed, if you need to install you can click here to check out how can you do that. After installed the only thing you need is export the variables that you like and run the compose as command available below:
$ git clone https://github.com/pedrocesar-ti/internet-speedtest-docker.git
$ cd internet-speedtest-docker
$ docker-compose up -d Docker Compose
As you probably know Docker Compose is a tool to let you running a multi-container application, so as I sad before I put together some contaiers to make everything work together. They are described below:
InfluxDB (DB)
InfluxDB is a database tool based on time-series, so every event is registrate with their timestamp. I decided to use InfluxDB at first because has great integration with Grafana and second I don't take cara about timestamp and how generate the graphs based on time.
I used tutumcloud/influxdb image because is very useful and all parametrized so is easy to use.
You can customize some actions with variables listed below:
| Variables | Default | Function |
|---|---|---|
| ADMIN_USER | admin | Set root user for the database. |
| INFLUXDB_INIT_PWD | password | Set the password for the root user. |
| PRE_CREATE_DB | password | Create a database speedtest when container starts. |
Grafana (Web)
Grafana is a tool to create and manage dashboards and graphs. It's a really cool tool and as I sad earlier has a perfect integration with InfluxDB.
When I started this project I used tutumcloud/grafana image, however they stopped to update grafana image beacause the new version has a different way to be installed, so it's deprecated. So I used grafana original image as a base system to generate my own image.
You can also customize this image with few variables:
| Variables | Default | Function |
|---|---|---|
| GF_SERVER_ROOT | http://localhost | Set URL to configure Grafana built-in web server. |
| GF_SECURITY_ADMIN_PASSWORD | Default without password. | This is a password to access the Grafana Dashboard. |
SpeedTest (Testing)
This image was created to run a script that calls speedtest-cli to test the internet connect and save data on InfluxDB. SpeedTest is a tool written in Python and is used to test your Internet connection based on donwload and upload some content from servers configured previously.
The only variable to customize on this image is a variable to set the frequency that this script will run.
| Variables | Default | Function |
|---|---|---|
| TIME_INTERVAL | 600 | Time (in sec.) to set how long will sleep the script until run again. |
Repositories used to
Enjoy! :)