added README

This commit is contained in:
2026-02-23 03:46:24 +01:00
parent 176ae47ece
commit 90194076a6
3 changed files with 33 additions and 5 deletions

View File

@@ -0,0 +1,28 @@
# speed-logger
Runs periodic internet speed tests using the Cloudflare speed test API and visualizes the results in Grafana. Tests run every 15 minutes and record download speed, upload speed, latency, and jitter. Results are stored in a SQLite database and displayed on a pre-configured Grafana dashboard.
![Dashboard](res/dashboard.png)
## Requirements
- Docker and Docker Compose
## Deployment
Create a `.env` file in the project root with the following variables:
```
GRAFANA_PORT=3000
GRAFANA_ADMIN_USER=admin
GRAFANA_ADMIN_PASSWORD=changeme
```
Start the containers:
```
docker compose up -d
```
Grafana will be available at `http://localhost:3000`. The dashboard is provisioned automatically on first start.

View File

@@ -31,7 +31,7 @@
}, },
"id": 100, "id": 100,
"panels": [], "panels": [],
"title": "📊 Summary", "title": "Summary",
"type": "row" "type": "row"
}, },
{ {
@@ -482,7 +482,7 @@
}, },
"id": 101, "id": 101,
"panels": [], "panels": [],
"title": "📈 Speed Over Time", "title": "Speed Over Time",
"type": "row" "type": "row"
}, },
{ {
@@ -860,7 +860,7 @@
}, },
"id": 102, "id": 102,
"panels": [], "panels": [],
"title": "🕐 Time-of-Day & Weekday Patterns", "title": "Time-of-Day & Weekday Patterns",
"type": "row" "type": "row"
}, },
{ {
@@ -1261,7 +1261,7 @@
}, },
"id": 103, "id": 103,
"panels": [], "panels": [],
"title": "🔴 Uptime & Failures", "title": "Uptime & Failures",
"type": "row" "type": "row"
}, },
{ {
@@ -1400,7 +1400,7 @@
}, },
"id": 104, "id": 104,
"panels": [], "panels": [],
"title": "🗃️ Raw Data", "title": "Raw Data",
"type": "row" "type": "row"
}, },
{ {

BIN
res/dashboard.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 566 KiB