From 0bec94fce9727e77fb098e055443d7a7d441a80e Mon Sep 17 00:00:00 2001 From: Ben Rometsch Date: Fri, 20 Dec 2024 15:25:09 +0000 Subject: [PATCH] docs: tidy up edge proxy health check (#4935) --- docs/docs/deployment/hosting/locally-edge-proxy.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/docs/docs/deployment/hosting/locally-edge-proxy.md b/docs/docs/deployment/hosting/locally-edge-proxy.md index 76304a97f60d..2b91fb734214 100644 --- a/docs/docs/deployment/hosting/locally-edge-proxy.md +++ b/docs/docs/deployment/hosting/locally-edge-proxy.md @@ -253,6 +253,8 @@ fetch all its configured environment documents. If any environment document coul grace period, the health check will fail with a 500 status code. This allows the Edge Proxy to continue reporting as healthy even if the Flagsmith API is temporarily unavailable. +You can point your orchestration health checks to this endpoint. + #### `health_check.environment_update_grace_period_seconds` Default: `30`. @@ -281,20 +283,10 @@ You can configure the Edge Proxy with the following environment variables: - `WEB_CONCURRENCY` The number of [Uvicorn](https://www.uvicorn.org/) workers. Defaults to `1`. Set to the number of available CPU cores. -- `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`, `NO_PROXY`: These variables let you configure an HTTP proxy that the +- `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`, `NO_PROXY`: These variables let you configure an HTTP proxy that the Edge Proxy should use for all its outgoing HTTP requests. [Learn more](https://www.python-httpx.org/environment_variables) -## Monitoring - -There are 2 health check endpoints for the Edge Proxy. - -### SDK Proxy Health Check - -When making a request to `/proxy/health` the proxy will respond with a HTTP `200` and `{"status": "ok"}`. You can point -your orchestration health checks to this endpoint. This endpoint checks that the -[Environment Document](/clients#the-environment-document) is not stale, and that the proxy is serving SDK requests. - ## Architecture The standard Flagsmith architecture: