Mirrors/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-23 02:24:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Document how to disable the metrics interfaces

Browse source
This commit is contained in:
Florian Preinstorfer 2025-12-19 05:43:08 +01:00 • committed by nblock
parent 3689f05407
commit 7d81dca9aa
2 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
config-example.yaml
View file

@ -20,6 +20,7 @@ listen_addr: 127.0.0.1:8080
# Address to listen to /metrics and /debug, you may want # Address to listen to /metrics and /debug, you may want
# to keep this endpoint private to your internal network # to keep this endpoint private to your internal network
# Use an emty value to disable the metrics listener.
metrics_listen_addr: 127.0.0.1:9090 metrics_listen_addr: 127.0.0.1:9090
# Address to listen for gRPC. # Address to listen for gRPC.

3
docs/ref/debug.md
View file

@ -64,6 +64,9 @@ Headscale provides a metrics and debug endpoint. It allows to introspect differe
Keep the metrics and debug endpoint private to your internal network and don't expose it to the Internet. Keep the metrics and debug endpoint private to your internal network and don't expose it to the Internet.
The metrics and debug interface can be disabled completely by setting `metrics_listen_addr: null` in the
[configuration file](./configuration.md).
Query metrics via <http://localhost:9090/metrics> and get an overview of available debug information via Query metrics via <http://localhost:9090/metrics> and get an overview of available debug information via
<http://localhost:9090/debug/>. Metrics may be queried from outside localhost but the debug interface is subject to <http://localhost:9090/debug/>. Metrics may be queried from outside localhost but the debug interface is subject to
additional protection despite listening on all interfaces. additional protection despite listening on all interfaces.