CRThaze/speedporter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document exported metrics

Browse Source
This commit is contained in:
Diego Fernando Carrión 2024-10-20 15:05:31 +02:00
parent c407f5c011
commit e8fcea05e2
Signed by: CRThaze
GPG Key ID: 8279B79A1A7F8194
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -14,6 +14,15 @@ The following environment variables can be used to configure the daemon:
| `SPEEDTEST_PERIOD_MINS` | `5` | How often to run the test |
| `SPEEDTEST_EXEC` | `/usr/bin/speedtest` | The Path to the Ookla Speedtest Executable |
### Exported Prometheus Metrics
| Name | Unit | Description |
| --- | --- | --- |
| `isp_download_speed` | Mb/s | Download Bandwidth |
| `isp_upload_speed` | Mb/s | Upload Bandwidth |
| `isp_ping_latency` | ms | Internet Connection Latency |
| `isp_packet_loss` | % | Percentage of Packets Lost During Test |
## Dependencies
Install the [Ookla Speedtest CLI](https://www.speedtest.net/apps/cli)