From 212809837c704a14c620b2b01bd7992b9c5f2df0 Mon Sep 17 00:00:00 2001 From: Richard Steinmetz Date: Tue, 16 Sep 2025 11:43:10 +0200 Subject: [PATCH] docs(readme): mention METRICS_SOCKET_PATH env variable Signed-off-by: Richard Steinmetz --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0047bf16..26704135 100644 --- a/README.md +++ b/README.md @@ -349,11 +349,14 @@ Alternatively you can set the log level of the push server in the `LOG` environm The push server can expose some basic metrics about the number of connected clients and the traffic flowing through the server by setting the `METRICS_PORT` environment variable. +The metrics endpoint will listen on all interfaces by default (0.0.0.0). +However, it is also possible to bind the metrics listener to a local UNIX socket by specifying a path via the +`METRICS_SOCKET_PATH` environment variable. -Once set the metrics are available in a prometheus compatible format at `/metrics` on the configured port. +Once set the metrics are available in a prometheus compatible format at `/metrics` on the configured port or UNIX socket. Additionally you can manually check the metrics by running the `occ notify_push:metrics` command, this will function -even if you haven't setup `METRICS_PORT`. +even if you haven't setup `METRICS_PORT` or `METRICS_SOCKET_PATH`. ### Self-signed certificates