diff --git a/.gitbook/assets/prometheus_settings.png b/.gitbook/assets/prometheus_settings.png new file mode 100644 index 0000000..ca3b1ff Binary files /dev/null and b/.gitbook/assets/prometheus_settings.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 7e69673..ecc88f0 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -31,6 +31,7 @@ * [Data Integrations](settings/data-platforms/README.md) * [InfluxDB v2](settings/data-platforms/influxdb2.md) + * [Prometheus](settings/data-platforms/prometheus.md) * [Notifications](settings/notifications/README.md) * [Database](settings/notifications/database.md) * [Mail](settings/notifications/mail.md) diff --git a/settings/data-platforms/prometheus.md b/settings/data-platforms/prometheus.md new file mode 100644 index 0000000..ed416d3 --- /dev/null +++ b/settings/data-platforms/prometheus.md @@ -0,0 +1,31 @@ +# Prometheus + +After each test, Speedtest Tracker exposes the metrics for Prometheus to scrape. For long term storage or custom visualizations. + +### Authentication + +To configure Speedtest Tracker to expose its metrics behind `basic auth`, apply the following settings + +
NameDefaultDescription
Use Basic AuthenticationfalseEnable / Disable Basic Auth
usernameblankusername for authentication
passwordblankpassword for authentication
+ +
+ +### Data pattern + +Speedtest Tracker exports data in two categories: labels and metrics. Labels are used for filtering, while metrics are used for displaying data. + +
Name
app_namelabel
isplabel
server_idlabel
server_namelabel
server_countrylabel
server_locationlabel
healthylabel
statuslabel
scheduledlabel
download_bytesMetric
upload_bytesMetric
pingMetric
download_bitsMetric
upload_bitsMetric
download_jitterMetric
upload_jitterMetric
ping_jitterMetric
download_latency_avgMetric
download_latency_highMetric
download_latency_lowMetric
upload_latency_avgMetric
upload_latency_highMetric
upload_latency_lowMetric
packet_lossMetric
+ +### Prometheus Scrape Config + +Below is an example Prometheus scrape configuration: + +```yaml +scrape_configs: + - job_name: 'speedtest-tracker' + scrape_interval: 60s # Adjust to your set schedule + scrape_timeout: 10s + metrics_path: /prometheus + static_configs: + - targets: ['speedtest-tracker.local'] +```