From bb3fe4f8303f8b80bfc34a6600c38fcc252211f9 Mon Sep 17 00:00:00 2001 From: binwiederhier Date: Wed, 15 Mar 2023 20:58:09 -0400 Subject: [PATCH] Docs WIP --- docs/config.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/config.md b/docs/config.md index 33195eb..ccb1122 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1099,6 +1099,14 @@ If a non-200 HTTP status code is returned or if the returned `health` field is ` See [Installation for Docker](install.md#docker) for an example of how this could be used in a `docker-compose` environment. +## Metrics +If configured, ntfy can expose a `/metrics` endpoint for [Prometheus](https://prometheus.io/), which can then be used to +create dashboards and alerts (e.g. via [Grafana](https://grafana.com/)). + +To configure the metrics endpoint, set the `listen-metrics-http` option to a listen address + +XXXXXXXXXXXXXXXXXXX + ## Logging & debugging By default, ntfy logs to the console (stderr), with an `info` log level, and in a human-readable text format.