From 8ba7ca44b6794aa38819cf18993a9c5861ac1aba Mon Sep 17 00:00:00 2001 From: Abel Luck Date: Mon, 6 Nov 2023 11:59:58 +0100 Subject: [PATCH] document prom metrics exposed --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index f502e94..8005edf 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,24 @@ TAILSCALESD_API_KEY=my-api-key TAILSCALESD_HOST=127.0.0.1 ``` +### Monitoring + + +This service provides the following Prometheus metrics: + +- `tailscalesd_unhandled_background_task_crashes` + - **Type**: Counter + - **Description**: The number of unhandled background task crashes. This counter increases every time a background task crashes without being handled by the application. +- `tailscalesd_matrix_sd_down` + - **Type**: Counter + - **Description**: The number times a matrix sd host was unreachable. This counter increments each time a connection attempt to a matrix sd host fails. + - **Labels**: + - `device_hostname`: The hostname of the device that was unreachable. + +It also provides HTTP server metrics from [trallnag/prometheus-fastapi-instrumentator](https://github.com/trallnag/prometheus-fastapi-instrumentator) + +## Dev + ### Running the Application 1. **Install Dependencies**: Ensure that all required dependencies are installed.