Skip to content

Commit dcab192

Browse files
authored
docs: Add Edge Proxy liveness and readiness checks (#5306)
1 parent f4581c9 commit dcab192

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

docs/docs/deployment/hosting/locally-edge-proxy.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -266,14 +266,17 @@ Or, log access logs to file in generic format while logging everything else to s
266266
When adding logger configurations, you can use the `"default"` handler which writes to stdout and uses formatter
267267
specified by the [`"logging.log_format"`](#logginglog_format) setting.
268268

269-
### Health check
269+
### Health checks
270270

271-
The Edge Proxy exposes a health check endpoint at `/proxy/health` that responds with a 200 status code if it was able to
272-
fetch all its configured environment documents. If any environment document could not be fetched during a configurable
273-
grace period, the health check will fail with a 500 status code. This allows the Edge Proxy to continue reporting as
274-
healthy even if the Flagsmith API is temporarily unavailable.
271+
The Edge Proxy exposes two health check endpoints:
275272

276-
You can point your orchestration health checks to this endpoint.
273+
* `/proxy/health/liveness`: Always responds with a 200 status code. Use this health check to determine if the Edge
274+
Proxy is alive and able to respond to requests.
275+
* `/proxy/health/readiness`: Responds with a 200 status if the Edge Proxy was able to fetch all its configured
276+
environment documents within a configurable grace period. This allows the Edge Proxy to continue reporting as healthy
277+
even if the Flagsmith API is temporarily unavailable. This health check is also available at `/proxy/health`.
278+
279+
You should point your orchestration health checks to these endpoints.
277280

278281
#### `health_check.environment_update_grace_period_seconds`
279282

0 commit comments

Comments
 (0)