Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dbrennand/speeder

Python script to monitor your internet speed! 🚀 Periodically run librespeed/speedtest-cli and send results to InfluxDB.
https://github.com/dbrennand/speeder

docker docker-compose grafana influxdb internet-speed internet-speed-tester python speeder speedtest

Last synced: 17 days ago
JSON representation

Python script to monitor your internet speed! 🚀 Periodically run librespeed/speedtest-cli and send results to InfluxDB.

Host: GitHub
URL: https://github.com/dbrennand/speeder
Owner: dbrennand
License: mit
Created: 2021-01-14T11:47:42.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-09-03T07:47:11.000Z (4 months ago)
Last Synced: 2024-11-30T22:47:11.456Z (25 days ago)
Topics: docker, docker-compose, grafana, influxdb, internet-speed, internet-speed-tester, python, speeder, speedtest
Language: Python
Homepage:
Size: 921 KB
Stars: 15
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Speeder

![Build](https://github.com/dbrennand/speeder/actions/workflows/build.yml/badge.svg)

![Lint](https://github.com/dbrennand/speeder/actions/workflows/lint.yml/badge.svg)

Python script to monitor your internet speed! 🚀

Periodically run [librespeed/speedtest-cli](https://github.com/librespeed/speedtest-cli) and send results to [InfluxDB](https://www.influxdata.com/products/influxdb/).

# Quick Start

> **Note**

> The assumption is made that you've already setup `InfluxDB 2.x.x`. Alternatively, you can use the [Docker Compose](#docker-compose-stack---influxdb-and-grafana) method where this is setup for you.

List available server IDs:

```bash

docker run --rm -it ghcr.io/dbrennand/speeder:latest /librespeed --list

```

Next, start and configure speeder using the environment variables:

```bash

docker run -itd --rm --name speeder \

    -e "SPEEDER_SPEEDTEST_INTERVAL=300" \

    -e "SPEEDER_SPEEDTEST_SERVER_ID=49" \

    -e "SPEEDER_INFLUXDB_HOST=influx.example.com" \

    -e "SPEEDER_INFLUXDB_TOKEN=" \

    -e "SPEEDER_INFLUXDB_ORG=speeder" \

    -e "SPEEDER_INFLUXDB_BUCKET=speeder" \

    ghcr.io/dbrennand/speeder:latest

```

# Environment Variables

The [speeder](speeder.py) script is configured using the below environment variables:

| Name                          | Description                                                                                | Default Value |

| ----------------------------- | ------------------------------------------------------------------------------------------ | ------------- |

| `SPEEDER_SPEEDTEST_INTERVAL`  | Interval in seconds to run speedtests on.                                                  | 300           |

| `SPEEDER_SPEEDTEST_SERVER_ID` | Server ID to run speedtests against. Supports multiple IDs using a comma separated string. | ""            |

| `SPEEDER_INFLUXDB_HOST`       | InfluxDB hostname.                                                                         | influxdb      |

| `SPEEDER_INFLUXDB_PORT`       | InfluxDB port.                                                                             | 8086          |

| `SPEEDER_INFLUXDB_TOKEN`      | InfluxDB token.                                                                            | root          |

| `SPEEDER_INFLUXDB_ORG`        | InfluxDB organisation name.                                                                | speeder       |

| `SPEEDER_INFLUXDB_BUCKET`     | InfluxDB bucket name to write speedtest results to.                                        | speeder       |

# Docker Compose Stack - InfluxDB and Grafana

The [docker-compose.yml](docker-compose.yml) file in this repository will deploy speeder, InfluxDB `2.7.1` and Grafana containers. Grafana will be provisioned with InfluxDB as the [data source](grafana-config/datasources/datasource.yml) and the pre-created [dashboard](grafana-config/dashboards/dashboard.json):

![Dashboard](images/dashboard.png)

![Dashboard 1](images/dashboard1.png)

1. Set the `SPEEDER_SPEEDTEST_SERVER_ID` environment variable located in the [.env](.env) file to the server IDs to perform speedtests against.

    > **Note**

    >

    > If you don't know any server IDs, run the following command to list them:

    > ```bash

    > docker run --rm -it ghcr.io/dbrennand/speeder:latest /librespeed --list

    > ```

2. Set the `DOCKER_INFLUXDB_INIT_PASSWORD`, `DOCKER_INFLUXDB_INIT_ADMIN_TOKEN` and `GF_SECURITY_ADMIN_PASSWORD` environment variables located in the [.env](.env) file.

3. Start the compose stack:

    ```bash

    docker compose up -d

    ```

Grafana will be accessible at [`http://localhost:3000`](http://localhost:3000) and your host's IP address.

## Disclaimer

I did **NOT** create the LibreSpeed project or CLI. The great folks over at [LibreSpeed](https://github.com/librespeed) did.

If you like this project then please give their repositories a star! ⭐

## Authors -- Contributors

[**Daniel Brennand**](https://github.com/dbrennand) - *Author*

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) for details.