Skip to content

Commit

Permalink
docs: tidy up edge proxy health check (#4935)
Browse files Browse the repository at this point in the history
  • Loading branch information
dabeeeenster authored Dec 20, 2024
1 parent 2e75fbc commit 0bec94f
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions docs/docs/deployment/hosting/locally-edge-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 0bec94f

Please sign in to comment.