Automated docker speedtest analyser tool with included web interface to monitor your internet speed connection over time. Setup at home on your NAS (Synology, QNAP tested) and the container runs hourly speedtests. The speedtest results are displayed in an webinterface as line graph(s) over the day.
License: Other
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
Hi - I've been using this and its worked well but due to the inconsistencies in speed with the speedtest-cli library you are using, I am having to look for an alternative.
Example - I have a 1gig connection. My speed max's at 500 through the current library regardless of server that I try.
Speedtest.net . have released an official speedtest cli library here - https://www.speedtest.net/apps/cli
Any chance of an option of using this? I've tried this via cmd line and it works as expected.
Would be awesome to have an updated Docker image that executes this instead.
Thanks
docker-speedtest-analyser use a result.csv as database.
Data addet per speedtest ~35 bytes
35 * 24 = 840 bytes per day
840 * 365 = 306.500 bytes (306,5 kilobyte) per year
The default setting for a speedtest is 12/hour.
Data addet per speedtest ~35 bytes
35 * 12 = 420 per hour
420 * 24 = 10.080 bytes per day
10.080 * 365 = 3.679.200 bytes (3679,2 kilobyte / 3,6792 MB) per year
file based database system is acceptable when speedtest scaled up to run every 5 minutes for 75 years
to scale? the stored data and allow querying data this project may switch to another database system.
Not sure if this is the right way to contact you, but:
I'm running a Synology 718+ and have installed your docker image. I think I have correctly mounted the volume to access the csv file, as I see it in the folder.
However I seem to be having trouble accessing the web interface for it. Should I be setting a constant port for the interface on the 443 and 80 ports; do I only need to access one; which one?
Thanks in advance.
The timestamps in the CSV file are showing up as a decimal rather than a date.
Hi there
I really love your docker speedtest, it is just great!
Luckily I have a very fast internet connection with low latency. Therefore, I can hardly see the latency results (~6ms) in comparison to the full axis (~1000Mbit). So it would be great if you could move the ping results to a secondary axis ;). That would be amazing!
Furthermore, did you ever think of some smoothening? Especially for larger timeframes, it is hard to say anything about the long-time speed behaviour....
Anyway, thanks a lot for your great work :)!!
Hi,
I've installed this on my Synology NAS and can see from the logs it runs the first speedtest perfectly, however the container then stops unexpectedly. I think this is maybe when it's trying to write the results to the csv file? When creating the container I mounted /var/www/html/data/ to an empty folder on my NAS, I didn't bridge the network and added port 80 to the port map tab.
Any ideas gratefully received.
Nick
Hi, I recently added a VPN service to my NAS, and now the speedtest client fails. Any idea why? Cheers.
Hi all,
I am using Docker Run to start the container with the code
docker run -d \ --name=speedtest \ -p 7123:80 \ -v /home/myuser/Containers/Config/speedtest/results:/var/www/html/data/ \ roest/docker-speedtest-analyser
I am on Ubuntu 20.04.
Whenever I try to do a speedtest from the it does not log the result to a file or show the result on the web Ui. If I run the container without persistent storage it works fine.
The browser console says Failed to load resource: the server responded with a status of 404 (Not Found) & Failed to load resource: the server responded with a status of 404 (Not Found)
I know the volume is mounted correctly as if I create result.csv in the directory I can see the results.csv when I bash into the container. If I also bash into the container I am able to create the result.csv
The container logs just show
2020-12-25T17:27:58.608597551Z --- running speedtest --- 2020-12-25T17:32:28.631339859Z --- running speedtest --- 2020-12-25T17:33:18.912350739Z --- running speedtest ---
and lots of this
2020-12-25T17:27:25.056834316Z nginx: [alert] detected a LuaJIT version which is not OpenResty's; many optimizations will be disabled and performance will be compromised (see https://github.com/openresty/luajit2 for OpenResty's LuaJIT or, even better, consider using the OpenResty releases from https://openresty.org/en/download.html) 2020-12-25T17:27:25.058034978Z nginx: [error] lua_load_resty_core failed to load the resty.core module from https://github.com/openresty/lua-resty-core; ensure you are using an OpenResty release from https://openresty.org/en/download.html (rc: 2, reason: module 'resty.core' not found: 2020-12-25T17:27:25.058042767Z no field package.preload['resty.core'] 2020-12-25T17:27:25.058044841Z no file './resty/core.lua' 2020-12-25T17:27:25.058046407Z no file '/usr/share/luajit-2.1.0-beta3/resty/core.lua' 2020-12-25T17:27:25.058047914Z no file '/usr/local/share/lua/5.1/resty/core.lua' 2020-12-25T17:27:25.058049396Z no file '/usr/local/share/lua/5.1/resty/core/init.lua' 2020-12-25T17:27:25.058050857Z no file '/usr/share/lua/5.1/resty/core.lua' 2020-12-25T17:27:25.058052295Z no file '/usr/share/lua/5.1/resty/core/init.lua' 2020-12-25T17:27:25.058053892Z no file '/usr/share/lua/common/resty/core.lua' 2020-12-25T17:27:25.058055396Z no file '/usr/share/lua/common/resty/core/init.lua' 2020-12-25T17:27:25.058056919Z no file './resty/core.so' 2020-12-25T17:27:25.058058397Z no file '/usr/local/lib/lua/5.1/resty/core.so' 2020-12-25T17:27:25.058059827Z no file '/usr/lib/lua/5.1/resty/core.so' 2020-12-25T17:27:25.058061244Z no file '/usr/local/lib/lua/5.1/loadall.so' 2020-12-25T17:27:25.058062695Z no file './resty.so' 2020-12-25T17:27:25.058064086Z no file '/usr/local/lib/lua/5.1/resty.so' 2020-12-25T17:27:25.058065663Z no file '/usr/lib/lua/5.1/resty.so' 2020-12-25T17:27:25.058067213Z no file '/usr/local/lib/lua/5.1/loadall.so')
Hi Tobias,
Thank you for contributing your analyses. i am running this on my Synology NAS and it looks great but one problem: I think the European date format isn’t working right for me in the US. When I look at the chart of results, the time axis simply says “Invalid date” for all values. I apologize for reaching out directly, but I think this must be a simple fix. Could you help?Jon
Hi, how can we set the timezone of this docker. Running bash command "date" in terminal gives me ETC/UTC, which is the default timezone. I tried putting TZ - Australia/Brisbane, but it doesn't seem to change the timezone within the docker. Can you implement this functionality please?
Chapter CONFIG starts with saying
You can configure the visualization frontend via appConfig.js copy the /js/appConfig.example.js into /data/appConfig.js (where your volume should be mounted)
I guess /data/appConfig.js should be /var/www/html/data/appConfig.js? As this mount is described above.
Hello, is there a way to configure the timestamp's format as it is saved into the CSV? I am running the speedtest on Synology in a Docker but the current format does not allow me to read the date and time of measurement at all - as shown in the picture attached.
I tried to go through the instructions and parameters but this does not seem to be specified. Is there even a setting for that or where does that take the timestamp from so I can dig in there? Many thanks in advance for any advice.
Also big thanks for all your work with the speedtest. It's simply amazing and very handy tool which helped me to get my ISP's line performance fixed. :-)
Had to downgrade to 1.2 to get it to work on my Synology.
I have the program installed in a docker container on my synology unit. (DS918+) Everything works but the date is in the incorrect format (DD.MM.YYYY) I would like it to be displayed (MM.DD.YYYY). I have "copy appConfig.example.js into /data/appConfig.js to change values" without any noticable changes. I have tried both EN as well as US for the locale. Here is a copy of the appConfig file:
let appConfig = {
"customTitle": "Statistics for Real Nerds",
"dateFormat": "MM.DD.YYYY",
"locale": "US",
"labels": {
"download": "Download",
"ping": "Ping",
"upload": "Upload"
},
How can I chnage this to reflect US date format? Thank you.
Hey, thanks for the cool app! My connection tests 1500/60Mbits on speediest.net, but the container is capping at 3-400 down and 25 up. Where would I start to troubleshoot this?
From the README
nginx is prepared but not configured for SSL yet
Is there a way to configure using Synology DDNS certificate from Let's Encrypt? Or it should work given certificate configured for the NAS - is that what you meant?
Currently I can load the frontend fine via HTTP while HTTPS gets ERR_SSL_PROTOCOL_ERROR in Chrome.
Should we define these in the nginx config?
ssl_certificate $ssl_server_name.crt;
ssl_certificate_key $ssl_server_name.key;
I guess the load of the speedtest servers is higher around the full hour.
You could introduce an offset to get better results.
a) new environmental variable OFFSET which must be smaller than CRONJOB_ITERATION
e. g. let python sleep at the beginning of the script. cron stays the same.
b) choose random offset as default
There are some optional arguments in speedtest-cli which might be relevant.
Add option to extend the default speedtest command with custom options for example custom mini server.
First of all: thank you for your work!
Is it possible to add at least mininmal, maximal and average values for the measured values of the selected time period?
As a bonus standard deviation and variance would be very nice
best regards
I am looking for detailed instructions on how to change settings, specifically on Synology.
Issue #27 mentions a "Guide"... Is this referring to readme.md, or is there more somewhere?
I could use some more guidance:
While not too comfortable in the shell and as almost first-time docker user i was able to download and start the image and find it's web interface.
To log into the container i needed some googling, but then found out i needed to enable SSH on the DiskStation, log in (With PuTTY) and run sudo docker exec -ti {containername} /bin/bash
Now i can navigate the file system, access the log file, edit appConfig.js etc.
Open issues:
How to mount a volume for the log i did not figure out so far.
Also, Environment vars are alien to me, so...
To set the interval, CRONJOB_ITERATION=15? No... this is gone after logout... must be something permanent, written to the file system... Where?
Currently, the CRONJOB_ITERATION parameter nicely allows to customize the intervals. However, every interval starts at :00, e.g. 12:00h, 13:00h, etc..
The issue is that the Speedtest-Servers are typically overloaded at that time, resulting in distorted values - all Speedtests at :00 give way lower results than ones at uneven start times, like 12:13, 12:26, 12:39, whichever. I get way lower bandwith and pings at the :00 tests than any other time.
This issue can be partially solved by putting an uneven CRONJOB_ITERATION parameter in, like CRONJOB_ITERATION=13. This gives good results at the times of 12:13, 12:26, etc. - but still one bad result at :00 start time.
It would be nicer to be able to further customize the crontab entry with an additional parameter CRONTAB_OFFSET, applying an offset, see:
https://stackoverflow.com/questions/12786410/run-cron-job-every-n-minutes-plus-offset
This would give more valid test results, omitting the :00 start time altogether.
Deprecation warning: moment construction falls back to js Date. This is discouraged and will be removed in upcoming major release. Please refer to moment/moment#1407 for more info.
Arguments: [object Object]
Error at Function.createFromInputFallback (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:8139) at Ca (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:12814) at Ba (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:12548) at Aa (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:12268) at Da (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:12991) at Ea (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:13025) at o.fb [as isAfter] (http://speedtest.nas:8085/js/libs/moment-with-locales.min.js:1:17378) at DateRangePicker.renderTimePicker (http://speedtest.nas:8085/js/libs/daterangepicker.js:871:34) at DateRangePicker.updateView (http://speedtest.nas:8085/js/libs/daterangepicker.js:506:22) at DateRangePicker.hoverRange (http://speedtest.nas:8085/js/libs/daterangepicker.js:1164:22) ea @ moment-with-locales.min.js:1
Would be fixed by updating the dangrossman/bootstrap-daterangepicker dep.
I use docker-compose:
version: "3.2"
services:
speedtest:
container_name: speedtest
image: roest/docker-speedtest-analyser
restart: unless-stopped
network_mode: bridge
volumes:
- ./speedtest/data:/var/www/html/data
ports:
- 8090:80
- 4343:443
environment:
- CRONJOB_ITERATION=30
Script is working properly. File result.csv is updating every 30 min, but the webpage is not updating.
Logs:
Starting run.sh
Starting Cronjob
Starting nginx
--- running speedtest ---
running with default server
ran
Ping: 26.528 ms
Download: 174.51 Mbit/s
Upload: 16.86 Mbit/s
08.03.2020 20:00:29
('08.03.2020 20:00:29', '26.52', '174.', '16.8')
speedtest complete
--- running speedtest ---
running with default server
ran
Ping: 19.655 ms
Download: 171.36 Mbit/s
Upload: 17.73 Mbit/s
08.03.2020 20:30:30
('08.03.2020 20:30:30', '19.65', '171.', '17.7')
speedtest complete
I would like to let this container run on a Raspberry 3 B+. Could you please add a armhf compatible version?
Actually, the container exits with the following logs:
speedtest_1 | standard_init_linux.go:190: exec user process caused "exec format error"
speedtestanalyser_speedtest_1 exited with code 1
Thanks in advance!
I use Synology docker, add SPEEDTEST_PARAMS and --server #### in Environment variables, but when I observed the process list, every time speedtest-cli only had --simple, --server not appeared...
Would there be a way to add a caching mechanic to the container for DNS? I run my own dns using PiHole and all devices are required to use it, outgoing connections aren't allowed on port 53. I've found that the server I'm running the speedtest-analyser on is checking dns for my ISP speedtest several times a second. One of the more recent times it did this there was 20 requests in 1 second (10 A and 10 AAAA). Is this something that can be fixed with the containers, or the server?
Hello,
could it be that SPEEDTEST_PARAMS is not read out? Because the parameters I enter there are not used.
With the latest release the docker speedtest does not work.
speedtest is not performed anymore. no automatic speedtests, no manual speedtest.
log when starting the image:
Starting run.sh
Starting Cronjob
Starting nginx
nginx: [alert] detected a LuaJIT version which is not OpenResty's; many optimizations will be disabled and performance will be compromised (see https://github.com/openresty/luajit2 for OpenResty's LuaJIT or, even better, consider using the OpenResty releases from https://openresty.org/en/download.html)
nginx: [error] lua_load_resty_core failed to load the resty.core module from https://github.com/openresty/lua-resty-core; ensure you are using an OpenResty release from https://openresty.org/en/download.html (rc: 2, reason: module 'resty.core' not found:
no field package.preload['resty.core']
no file './resty/core.lua'
no file '/usr/share/luajit-2.1.0-beta3/resty/core.lua'
no file '/usr/local/share/lua/5.1/resty/core.lua'
no file '/usr/local/share/lua/5.1/resty/core/init.lua'
no file '/usr/share/lua/5.1/resty/core.lua'
no file '/usr/share/lua/5.1/resty/core/init.lua'
no file '/usr/share/lua/common/resty/core.lua'
no file '/usr/share/lua/common/resty/core/init.lua'
no file './resty/core.so'
no file '/usr/local/lib/lua/5.1/resty/core.so'
no file '/usr/lib/lua/5.1/resty/core.so'
no file '/usr/local/lib/lua/5.1/loadall.so'
no file './resty.so'
no file '/usr/local/lib/lua/5.1/resty.so'
no file '/usr/lib/lua/5.1/resty.so'
no file '/usr/local/lib/lua/5.1/loadall.so')
EDIT:
Never mind! I just checked it and it’s working, I can see results in chart every hour! Not sure if it will store the results permanently but I can see how the connection was overnight which is what I wanted!
——
Apologies if this isn't the right place to ask such a basic question but I can't seem to get this working using the Docker GUI on my Synology NAS box. I can access the web interface and see a chart but it doesn't have any data.
Your instructions say "Moint host volume onto /var/www/html/data/", and I'm not 100% certain I've done that correctly.
What I've done with other docker containers is create a folder called "Docker" and then created subfolders for the config files for all my various containers, and then set the mount path for each container as instructed in the readme.
So in this case, I have a folder inside my Docker folder for this container, and I set the mount path to /var/www/html/data/ but it doesn't seem to actually do anything, I don't see any files appear in the folder I specified.
I've attached the log from the Docker GUI, seems to be trying to do something every few mins, but I don't see any errors that help me to resolve it.
If I haven't mounted the host volume correctly, I'd be really grateful if you could give me some more detailed help with that. Sorry again if this is really basic stuff!
I already had this tool installed on my NAS more than a year ago. I installed it again to the same NAS but this time it is not able to measure the real download speed. My ISP providing me download speed 120 Mbit/s and upload 10 Mbit/s what I can confirm on my router's speedtest tool but when I run your speedtest docker tool I can get just about 1Mbit/s. The upload speed is measured correctly just download speed not.
May I ask you for assistance regarding of this issue please?
Thanks in Advance
...psst! While Bower is maintained, we recommend using Yarn and Webpack for front-end projects read how to migrate!
Just started testing this, but my upload is faster than download so graph looks weird. is there some way to fix this in a smart way?
I'd like to reopen this as this bug definitely still exists.
It doesn't seem to affect the interface, but it's rather annoying when I want to use the csv data for other things and the timestamp is gibberish.
Originally posted by @paytah232 in #22 (comment)
Hi,
i installed yesterday the Docker container on my Snyology NAS. Since then i got with every test an error:
speedtest with extra parameter: speedtest-cli --simple --single --server 8198
ERROR: Malformed speedtest.net configuration: not well-formed (invalid token): line 1, column 6
Even when i login through terminal and just run "speedtest-cli", i got the same error. I also tried to upgrade the speedtest-cli within the container to the new version 2.1.2. But still the same error.
Someone else with the same problem?
As my graph shows, the speed-stats get quite unreadable because of big numbers in ping times...
Maybe it would be possible to do something like have Mbps on the left of the graph, and ms on the right?
Hi. Not sure why this is happening but oddly it seems that it might only occur when my NBN is down. Do you know why?
Hello guys,
I noticed after all the recent changes in this speedtest docker image the log (script) does not show the server speedtest was ran against anymore.
I have the SPEEDTEST_PARAMS set to execute against my ISP's server (ID 12722) but for past week my values of download got lower than usual which is a reason I got suspicious. When I run the speedtest from Docker command line (via Synology's DSM UI) against the server I set, I only get the error. That makes me believe the speedtest is not being actually executed against the predefined server.
Is it possible to get the server detail back into the log to see which server was actually used after all? Or anyone knowing why the server gets excluded in a first place (while the official speedtest-cli tool works with the same server just fine)?
Hi
Installed the docker but when it runs the python script it fails
bash-4.3# /var/www/html/scripts/speedtest.py
running speedtest
ERROR: <urlopen error [Errno -3] Try again>
ran
Cannot retrieve speedtest configuration12.09.2018 22:45:20
12.09.2018 22:45:20 100 0 0
speedtest complete
Also is there an environment variable like TZ which can fix local docker time?
I only found out after reading through some issues, that you can disable different metrics by clicking them in the Legend...
So i'd suggest adding a help text like Click labels to disable specific metrics.
in current setup the maximum value for CRONJOB_ITERATION is 60 because the value get parsed into the first cronjob setting.
May calculate the hours value from CRONJOB_ITERATION if > 60 and split them.
Example:
CRONJOB_ITERATION=360
expected result:
0 */6 * * * *
current result:
0/360 * * * *
What about crooked values?:
CRONJOB_ITERATION=365
expected result:
???
How do I test the application from a command line? I can exec into the container and mess around if needed, but she seems to have just stopped working for some reason?
The base OS is Ubuntu 20.04 and I must admit, I did run some updates yesterday for that, perhaps that's now broken it ?
What CLI command can I do to test what's going on?
I followed the guide to set this to 30mins, but it still only seems to run every hour???
Any way to fix it or test the new interval? Perhaps it's passing the wrong variable name or just not considering it and just defaulting to 60mins @roest01
I was trying to dig around and find the graph styling to make a change. Here is my example:
I'm running a 40mbps down, 2mbps up DSL line, with pings swinging from 40ms to 900ms. With the ping and u/d speed on the same graph axis the visual changes in the up/down become very hard to see.
Was looking to try and make the ping on a separate graph or if it could be on a second axis like this example-
https://www.chartjs.org/samples/latest/charts/line/multi-axis.html
Is there an easy way to alter the graph?
Thanks for the easy docker image for logging speed issues.
As user i want to have a button to start a speedtest manual in case i need an check of current result outside my normal iteration.
Blocked by #6
To allow calling speedtest.py via interface for #5 the speedtest service need a new structure
speedtest.py is called via cronjob on bash with python
speedtest.py script need to be called via http.
nginx has a build in FCGI-Server. Alternatively, we can use uwsgi ?
Example URL: http://localhost:9000/speedtest.py
keep speedtest.py callable via bash so the cronjob is working without modifications
I am analyzing a Problem with my DSL connection.
The Router from my provider can connect to an LTE modem and sum up LTE+DSL speeds.
Now when i turn off the LTE modem, the analyser shows a better upload of around 3.5mb/s vs. 2mb/s with LTE bonded, whereas the router's own stats and online speed tests show me the uplink actually goes down from 2 to below 1 mbps.
With LTE bonding, ping times go up (not so surprising), and uplink goes down in reality, but goes up in the graph:
I guess the faster response time leads to a wrong calculation of transmission speed.
I'm also getting the invalid date issue when I have a volume mounted in /var/www/html/data/ on my synology NAS. A bit of digging revealed that the result.csv file in /var/www/html/data/ when not mounted to the NAS has headers of timestamp,ping,download,upload but when this is mounted to somewhere on the NAS those headers are missing from the results.csv file. Manually adding timestamp,ping,download,upload to this file made the graph work for me.
Hopefully this makes sense to you as this is my 1st dip into doing anything with docker and synology.
Any questions I'm happy to provide whatever answers I can.
Hi @roest01,
how to supply a pull request for a feature when forking is forbidden by your license?
Best regards
erdnussflips
Can you explain the timestamp so I'm able to load the data in statistic software e.g. R?
This is one value of the .csv data file.
1562792378103.6838
Thanks
Noticed today that the docker wasn't running this container and got the titled error message. Should I try just reinstalling the docker?
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.