From eb19fe8b1d53c81ef187de1563b3ec760f0488bf Mon Sep 17 00:00:00 2001 From: Germano Eichenberg Date: Fri, 22 Apr 2022 12:37:56 -0300 Subject: [PATCH] Document /nirn/healthz --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d7ec8f..1b6f4d6 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ As projects grow, it's desirable to break them into multiple pieces, each respon This will vary depending on your usage, how many unique routes you see, etc. For reference, for Dynos use case, doing 150req/s, the usage is ~0.3 CPU and ~550MB of RAM. The proxy can comfortably run on a cheap VPS or an ARM based system. -### Metrics +### Metrics / Health | Key | Labels | Description | |------------------------------------|----------------------------------------|------------------------------------------------------------| @@ -105,6 +105,8 @@ This will vary depending on your usage, how many unique routes you see, etc. For Note: 429s can produce two status: 429 Too Many Requests or 429 Shared. The latter is only produced for requests that return with the x-ratelimit-scope header set to "shared", which means they don't count towards the cloudflare firewall limit and thus should not be used for alerts, etc. +The proxy has an internal endpoint located at `/nirn/healthz` for liveliness and readiness probes. + ### Profiling The proxy can be profiled at runtime by enabling the ENABLE_PPROF flag and browsing to `http://ip:7654/debug/pprof/`