https://github.com/cuducos/my-internet-speed
🛎️ Monitor the speed your ISP is delivering
https://github.com/cuducos/my-internet-speed
internet-speed isp monitoring
Last synced: about 2 months ago
JSON representation
🛎️ Monitor the speed your ISP is delivering
- Host: GitHub
- URL: https://github.com/cuducos/my-internet-speed
- Owner: cuducos
- License: gpl-3.0
- Archived: true
- Created: 2018-05-13T23:00:20.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2021-01-05T13:53:23.000Z (over 4 years ago)
- Last Synced: 2024-10-30T10:40:25.298Z (7 months ago)
- Topics: internet-speed, isp, monitoring
- Language: Python
- Homepage:
- Size: 134 KB
- Stars: 136
- Watchers: 14
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/cuducos/my-internet-speed)
[](https://codeclimate.com/github/cuducos/my-internet-speed)
[](https://codeclimate.com/github/cuducos/my-internet-speed)
# 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](#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.
* [Docker](https://docs.docker.com/install/)
* [Docker Compose](https://docs.docker.com/compose/install/)
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](https://apps.twitter.com/).
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](https://imgur.com/). 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:
1. Set `INTERVAL` according to how often (in minutes) you want to run the speed
test (e.g.: `20` for _20min_)
1. Set your `TIMEZONE` accordingly
The default speed test backend is [SpeedTest](https://speedtest.net) but you
can use
[EAQ (Entidade Aferidora da Qualidade de Banda Larga)](http://www.brasilbandalarga.com.br/)
certified by [ANATEL](https://www.anatel.gov.br/) setting `BACKEND` to
`brasil_banda_larga`.
If you want the app to post tweets:
1. Add your Twitter credentials at the top of the file
1. Set `CONTRACT_SPEED` to the speed in Mbps you are paying for (e.g.: `60` if
you contract says _60Mbps_)
1. Set `THRESHOLD` to the minimum percentage of the contract speed you contract
or local laws enforces your ISP (e.g.: `0.4` for 40%)
1. 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)
1. 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 `POSTGRES`s variables and the `PGRST` ones to
somewhere else).
Thus if you are using the Docker database it is useful to start it manually
first:
```console
$ docker-compose up -d db
```
In both cases run this one off command to create the database tables:
```console
$ docker-compose run --rm beat python \
-c "from my_internet_speed.models import Result; Result.create_table()"
```
### Spinning up the app
```console
$ 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](https://postgrest.org/en/v5.0/api.html) for advanced filtering and exporting formats) |
| `flower` | `http://localhost:5555/` | ✅ | [Flower](https://flower.readthedocs.io/) 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](https://speedtest.net/) | `my_internet_speed.backends.speed_test_net.SpeedTest` | ✅ |
| [Barsil Banda Larga](http://www.brasilbandalarga.com.br/) | `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:
1. 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`
2. 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`
3. The database I run **in the cloud**, a free tier at _tiny turtle_ (free) at
[ElephantSQL](https://www.elephantsql.com/)
#### 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:
```console
$ export DOCKER_CLIENT_TIMEOUT=600
$ export COMPOSE_HTTP_TIMEOUT=600
```
## Testing
```console
$ docker-compose run --rm beat py.test
```
Also we use [Black](https://github.com/ambv/black) code formatter:
```console
$ docker-compose run --rm beat black . --check
```