cuducos / my-internet-speed Goto Github PK

View Code? Open in Web Editor NEW

136.0 14.0 13.0 137 KB

🛎️ Monitor the speed your ISP is delivering

License: GNU General Public License v3.0

Python 47.34% HTML 2.30% Elm 35.62% JavaScript 10.91% CSS 0.41% Dockerfile 3.41%

internet-speed isp monitoring

my-internet-speed's Introduction

My Internet Speed

I wrote this app so I can periodically monitor my internet speed and:

Collect data to build a report about the quality of the service provided by my ISP
Automatically tweet my ISP when the speed is lower than expected – surely optional
Store speed test results in PostgreSQL
Check all speed test results in a web API
Monitor all speed test tasks

At home this runs on my Raspberry Pi, but not all services are compatible — check my ideal setup for a suggestion on how to run these services.

Installing

Requirements

It is important to run this app in a computer connected to the internet via ethernet cable, not via wireless – this is the way to have some accuracy in testing the speed.

Optionally, if you want the Twitter feature to work (it will only tweet when the speed is below the configures threshold):

Twitter consumer key and secret
Twitter access token and access token secret

You can get these Twitter credentials at the Twitter Application Management dashboard.

Some speed test backends do not provide a URL with the results. In these cases we take a screenshot from the speed test result and upload it to Imgur. If you want to use this feature, you need an account there and a client ID for a registered application.

Settings

Before you get started, copy .env.sample as .env and edit as follows:

Set INTERVAL according to how often (in minutes) you want to run the speed test (e.g.: 20 for 20min)
Set your TIMEZONE accordingly

The default speed test backend is SpeedTest but you can use EAQ (Entidade Aferidora da Qualidade de Banda Larga) certified by ANATEL setting BACKEND to brasil_banda_larga.

If you want the app to post tweets:

Add your Twitter credentials at the top of the file
Set CONTRACT_SPEED to the speed in Mbps you are paying for (e.g.: 60 if you contract says 60Mbps)
Set THRESHOLD to the minimum percentage of the contract speed you contract or local laws enforces your ISP (e.g.: 0.4 for 40%)
Set your tweet message using {contract_speed} where the contract speed in Mbps should be (for example, 60 for 60Mbps), {real_speed} where the measured speed should be, and {percentage} where comparing both should be (feel free to use the Twitter handle of your ISP too)
Add {result_url} in order to add the link to the result provided by the speed test backend

For example, if:

the measured speed is 20Mpbs
your CONTRACT_SPEED is 60
the THRESHOLD is 0.4
and TWEET is configures as I pay for {contract_speed}, but now @MyISP is working at {real_speed} – merely {percentage} of what I'm paying for :( {result_url}

The final tweet would be:

I pay for 60Mbps, but now @MyISP is working at 20Mbps – merely 33% of what I'm paing for :( http://www.speedtest.net/result/7307126311

If you like this app, add #MyInternetSpeed https://github.com/cuducos/my-internet-speed to your tweets ; )

Database

This docker-compose.yml lefts out the db container from all possible depends_on in order to make it easier to use an external/remote database to persist data (just point POSTGRESs variables and the PGRST ones to somewhere else).

Thus if you are using the Docker database it is useful to start it manually first:

$ docker-compose up -d db

In both cases run this one off command to create the database tables:

$ docker-compose run --rm beat python \
  -c "from my_internet_speed.models import Result; Result.create_table()"

Spinning up the app

$ docker-compose up -d

Services and compatibility

Containers

This spins up different services that might be useful to check the status of the speed tests:

Name	URL	ARM (RaspberryPi) compatibility	Description
`beat`		✅	Main app that periodically runs the speed tests
`dashboard`	`http://localhost:3000/`	🚫	Minimalist dashboard with monthly speed test results
`api`	`http://localhost:3001/result/`	🚫	API to the database with all speed test results (check Postgrest for advanced filtering and exporting formats)
`flower`	`http://localhost:5555/`	✅	Flower dashboard for asynchronous tasks
`db`		✅	Database to store the speed test results
`broker`		✅	Queue to run the speed tests
`chrome`		🚫	Selenium web driver used for backends that requires a browser

Backends

Name	Python path	ARM (RaspberryPi) compatibility
SpeedTest	`my_internet_speed.backends.speed_test_net.SpeedTest`	✅
Barsil Banda Larga	`my_internet_speed.backends.brasil_banda_larga.SpeedTest`	🚫

My ideal setup

Given the ARM processor incompatibilities, I actually use three computers to run these services:

In my RaspberryPi (ARM processor, but it is still the only device with ethernet cable I have) I run beat, broker and flower:
$ docker-compose up -d beat flower
In my main computer (x86 processor) I run the api and the dashboard so I can check the results:
$ docker-compose up -d beat dashboard
The database I run in the cloud, a free tier at tiny turtle (free) at ElephantSQL

Troubleshooting

`UnixHTTPConnectionPool(host='localhost', port=None): Read timed out.`

I was getting this error in my Raspberry Pi when trying to run docker-compose up. This seams to be a workaround:

$ export DOCKER_CLIENT_TIMEOUT=600
$ export COMPOSE_HTTP_TIMEOUT=600

Testing

$ docker-compose run --rm beat py.test

Also we use Black code formatter:

$ docker-compose run --rm beat black . --check

my-internet-speed's People

Contributors

Stargazers

Watchers

Forkers

diraol diemesleno guibeira falcucci lipemorais shamanime ricaportela tassan teddymwai xirdigh hixio-mh krogees kyawgyi388013

my-internet-speed's Issues

Speed lower than 10%

Sometimes my speed is lower than 10% that I contract.

It will be nice if the speed lower than 10% that user contract, send an twitter to @anatel.

Just for information: 😭
https://twitter.com/NicolastarziaN/status/1000489073755213825

FailedConnectionException2 "github.com" 443 True getProtocolByName: does not exist (no such protocol name: tcp)

After run docker-compose up -d elm package manager is not able to download the package "cuducos/elm-format-number": "6.0.0 <= v < 7.0.0".

➜  my-internet-speed git:(master) docker-compose up -d
Building dashboard
Step 1/5 : FROM node:9.11.1-slim
 ---> 175a853f7bb2
Step 2/5 : WORKDIR /code
 ---> Using cache
 ---> 4ccafc0c8680
Step 3/5 : COPY elm-package.json .
 ---> Using cache
 ---> c033f836e391
Step 4/5 : RUN npm install -g npm@latest &&     npm install -g --unsafe-perm [email protected] &&     npm install -g --unsafe-perm [email protected] &&     elm package install --yes
 ---> Running in a6cf00605d9a
/usr/local/bin/npm -> /usr/local/lib/node_modules/npm/bin/npm-cli.js
/usr/local/bin/npx -> /usr/local/lib/node_modules/npm/bin/npx-cli.js
+ [email protected]
added 247 packages, removed 41 packages and updated 129 packages in 82.702s
npm WARN deprecated [email protected]: Use uuid module instead
/usr/local/bin/elm -> /usr/local/lib/node_modules/elm/binwrappers/elm
/usr/local/bin/elm-make -> /usr/local/lib/node_modules/elm/binwrappers/elm-make
/usr/local/bin/elm-package -> /usr/local/lib/node_modules/elm/binwrappers/elm-package
/usr/local/bin/elm-reactor -> /usr/local/lib/node_modules/elm/binwrappers/elm-reactor
/usr/local/bin/elm-repl -> /usr/local/lib/node_modules/elm/binwrappers/elm-repl

> [email protected] install /usr/local/lib/node_modules/elm
> node install.js

Downloading Elm binaries from https://dl.bintray.com/elmlang/elm-platform/0.18.0/linux-x64.tar.gz
+ [email protected]
added 94 packages from 69 contributors in 15.664s
npm WARN deprecated [email protected]: Use uuid module instead
/usr/local/bin/elm-app -> /usr/local/lib/node_modules/create-elm-app/bin/elm-app-cli.js
/usr/local/bin/create-elm-app -> /usr/local/lib/node_modules/create-elm-app/bin/create-elm-app-cli.js

> [email protected] install /usr/local/lib/node_modules/create-elm-app/node_modules/elm
> node install.js

Downloading Elm binaries from https://dl.bintray.com/elmlang/elm-platform/0.18.0/linux-x64.tar.gz

> [email protected] install /usr/local/lib/node_modules/create-elm-app/node_modules/elm-test
> node install.js

Downloading binaries from https://dl.bintray.com/elmlang/elm-test/0.18.12/linux-x64.tar.gz
Successfully downloaded and processed https://dl.bintray.com/elmlang/elm-test/0.18.12/linux-x64.tar.gz

> [email protected] postinstall /usr/local/lib/node_modules/create-elm-app/node_modules/uglifyjs-webpack-plugin
> node lib/post_install.js

npm WARN [email protected] requires a peer of ajv@^6.0.0 but none is installed. You must install peer dependencies yourself.
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/create-elm-app/node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/create-elm-app/node_modules/elm-test/node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

+ [email protected]
added 1302 packages from 733 contributors in 88.077s
Error: The following HTTP request failed.
<https://github.com/cuducos/elm-format-number/zipball/6.0.Starting downloads...

  ✗ debois/elm-dom 1.2.3
  ✗ elm-lang/html 2.0.0
  ✗ cuducos/elm-format-number 6.0.0
  ✗ elm-lang/core 5.1.1
  ✗ elm-lang/svg 2.0.0
  ✗ elm-lang/http 1.0.0
  ✗ elm-lang/virtual-dom 2.0.4
  ✗ eskimoblood/elm-color-extra 5.1.0
  ✗ justinmimbs/elm-date-extra 2.1.1
  ✗ mgold/elm-date-format 1.6.0
  ✗ fredcy/elm-parseint 2.0.0
  ✗ myrho/elm-round 1.0.2
  ✗ terezka/line-charts 1.0.0
0/>

FailedConnectionException2 "github.com" 443 True getProtocolByName: does not exist (no such protocol name: tcp)

ERROR: Service 'dashboard' failed to build: The command '/bin/sh -c npm install -g npm@latest &&     npm install -g --unsafe-perm [email protected] &&     npm install -g --unsafe-perm [email protected] &&     elm package install --yes' returned a non-zero code: 1

Problem with Elm in Raspberry Pi

The dashboard container doesn't build on Raspberry Pi.

See the log bellow:

    > node install.js

    Unfortunately, there are currently no Elm Platform binaries available for your operating system and architecture.

    If you would like to build Elm from source, there are instructions at https://github.com/elm-lang/elm-platform#build-from-source

    npm WARN This failure might be due to the use of legacy binary "node"
    npm WARN For further explanations, please read
    /usr/share/doc/nodejs/README.Debian

I saw that Daniel had this problem too, dev.to.

I think it's a problem with postgrest/postgrest image, because it is another architecture.