heathcliff26/speedtest-exporter repository overview

⁠speedtest-exporter

This project is a prometheus exporter for speedtests implemented in go. It runs automatically speedtests with the speedtest.net API and exports the result as prometheus metrics. It supports native speedtest by using speedtest-go⁠.

I created this project because i saw Jeff Geerling's⁠ video about his speedtest setup. When looking into it, he uses a python based speedtest-exporter⁠. At this point i could have just used that as well, but i was bored and wanted to program something. Hence this project.

One important functionality is that this projects implements prometheus remote_write, so it can push the metrics directly to e.g. grafana cloud.

⁠Table of Contents

• speedtest-exporter⁠
  • Table of Contents⁠
  • Container Images⁠
    • Image location⁠
    • Tags⁠
  • Usage⁠
  • Configuration⁠
  • Metrics⁠
  • Dashboard⁠

⁠Container Images

⁠Image location

⁠Tags

There are different flavors of the image:

⁠Usage

To run the image with default settings simply use:

podman run -d -p 8080:8080 ghcr.io/heathcliff26/speedtest-exporter:slim

You can then view your metrics under http://localhost:8080/metrics.

By default the last result will be cached to disk. To persist this between container runs, mount a volume at /cache:

podman run -d -p 8080:8080 -v speedtest-cache:/cache ghcr.io/heathcliff26/speedtest-exporter:slim

⁠Configuration

Output of speedtest-exporter -h

Usage of speedtest-exporter:
  -config string
        Optional: Path to config file
  -env
        Used together with -config, when set will expand enviroment variables in config
  -version
        Show the version information and exit

An example configuration can be found here⁠.

⁠Metrics

The following metrics are exported:

⁠Dashboard

A ready made dashboard for the exporter can be imported from json. The json file can be found here⁠.

The dashboard is also published on grafana.com with the id 20115⁠.

Here is a preview of the dashboard: