Skip to content

README.md

Latest commit

 

History

History
37 lines (25 loc) · 1.58 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.58 KB

Internet_SpeedTest_exporter

CodeQL CI/CD

version: 3.0.2

Prometheus Exporter for speedTest by Ookla.

It is containerized FastAPI based application to periodically perform internet SpeedTest and expose results for Prometheus Server to scrape.

Speedtests are performed in the background based on specified in .env frequency. Last speedtest result is available on ./metrics endpoint. Additionally there is /runOnDemand to trigger speedtest execution on demand. If program could not perform a test it will set all numeric values to 0 and string values to -

Important

/runOnDemand endpoint can be used with POST method only.

Grafana Dashboard

image image

Getting started

Review values in .env file and set it according to your needs.

  1. docker compose build to build docker image
  2. docker compose up -d to start docker container