IntenseWebs/uptime-kuma
3
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-23 15:40:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README to include examples for Prometheus

Browse Source
This commit is contained in:
Matthew Macdonald-Wallace 2021-07-22 15:02:33 +01:00
parent 3b45006567
commit a93fd274fd
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -86,6 +86,35 @@ npm run build
pm2 restart uptime-kuma pm2 restart uptime-kuma
``` ```
# Passing metrics to other platforms
If you already use [Prometheus.io](https://prometheus.io) or a platform that supports Prometheus exporter format, you can get the metrics about each monitoring target from `http://<your.installation>:<your_port>/metrics`.
Labels to filter by include:
| Label Name | Description |
+------------+-------------+
|monitor_name| The "Friendly Name" of the monitor |
|monitor_type| The type (http, keyword, tcp) of monitoring check |
|monitor_url | The URL to be monitored (http, keyword)
|monitor_hostname | The Hostname to be monitored (tcp) |
|monitor_port | The port to be monitored (tcp) |
## Example PromQL queries
Assuming we have http monitors in place for bbc.co.uk and google.com:
```
# Show all response rates gouped by site
sum(monitor_response_time) by (monitor_name)
# Show only the response time for BBC.co.uk
sum(monitor_reponse_time{monitor_url="https://www.bbc.co.uk/"})
# Show the current status of Google.com
monitor_status{monitor_name="Google"}
```
# What's Next? # What's Next?
I will mark requests/issues to the next milestone. I will mark requests/issues to the next milestone.