https://github.com/danopstech/speedtest_exporter
🏎️ Prometheus exporter that runs speedtest and exposes results
https://github.com/danopstech/speedtest_exporter
docker metrics prometheus prometheus-exporter speedtest
Last synced: about 2 months ago
JSON representation
🏎️ Prometheus exporter that runs speedtest and exposes results
- Host: GitHub
- URL: https://github.com/danopstech/speedtest_exporter
- Owner: danopstech
- License: gpl-3.0
- Created: 2021-04-15T08:07:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T11:57:55.000Z (about 2 years ago)
- Last Synced: 2024-11-05T21:45:21.028Z (7 months ago)
- Topics: docker, metrics, prometheus, prometheus-exporter, speedtest
- Language: Go
- Homepage:
- Size: 354 KB
- Stars: 54
- Watchers: 2
- Forks: 19
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Speedtest Prometheus Exporter
---
A [Speedtest](https://www.speedtest.net) exporter for Prometheus.
[](https://github.com/danopstech/speedtest_exporter/actions/workflows/release.yaml)
[](https://github.com/danopstech/speedtest_exporter/actions/workflows/build.yaml)
[](/LICENSE)
[](https://github.com/danopstech/speedtest_exporter/releases/latest)
[](https://hub.docker.com/r/danopstech/speedtest_exporter)
[](https://goreportcard.com/report/github.com/danopstech/speedtest_exporter)
## Usage:
### Flags
`speedtest_exporter` is configured by optional command line flags
```bash
$ ./speedtest_exporter --help
Usage of speedtest_exporter
-port string
listening port to expose metrics on (default "9090")
-server_fallback
If the serverID given is not available, should we fallback to closest available server
-server_id int
Speedtest.net server ID to run test against, -1 will pick the closest server to your location (default -1)
```
### Binaries
For pre-built binaries please take a look at the [releases](https://github.com/danopstech/speedtest_exporter/releases).
```bash
./speedtest_exporter [flags]
```
### Docker
Docker Images can be found at [GitHub Container Registry](https://github.com/orgs/danopstech/packages/container/package/speedtest_exporter) & [Dockerhub](https://hub.docker.com/r/danopstech/speedtest_exporter).
Example:
```bash
docker pull ghcr.io/danopstech/speedtest_exporter:latest
docker run \
-p 9090:9090 \
ghcr.io/danopstech/speedtest_exporter:latest [flags]
```
### Setup Prometheus to scrape `speedtest_exporter`
Configure [Prometheus](https://prometheus.io/) to scrape metrics from localhost:9090/metrics
This exporter locks (one concurrent scrape at a time) as it conducts the speedtest when scraped, **remember set scrape interval, and scrap timeout** accordingly as per example.
```yaml
...
scrape_configs
- job_name: speedtest
scrape_interval: 60m
scrape_timeout: 60s
static_configs:
- targets: ['localhost:9090']
...
```
## Exported Metrics:
```
# HELP speedtest_download_speed_Bps Last download speedtest result
# TYPE speedtest_download_speed_Bps gauge
# HELP speedtest_latency_seconds Measured latency on last speed test
# TYPE speedtest_latency_seconds gauge
# HELP speedtest_scrape_duration_seconds Time to preform last speed test
# TYPE speedtest_scrape_duration_seconds gauge
# HELP speedtest_up Was the last speedtest successful.
# TYPE speedtest_up gauge
# HELP speedtest_upload_speed_Bps Last upload speedtest result
# TYPE speedtest_upload_speed_Bps gauge
```
## Example Grafana Dashboard:
https://grafana.com/grafana/dashboards/14336
