Skip to content

docs: Add Edge Proxy liveness and readiness checks #5306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthewelwell merged 1 commit into from
Apr 8, 2025
Merged

docs: Add Edge Proxy liveness and readiness checks #5306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/docs/deployment/hosting/locally-edge-proxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,14 +245,17 @@ Or, log access logs to file in generic format while logging everything else to s
When adding logger configurations, you can use the `"default"` handler which writes to stdout and uses formatter
specified by the [`"logging.log_format"`](#logginglog_format) setting.

### Health check
### Health checks

The Edge Proxy exposes a health check endpoint at `/proxy/health` that responds with a 200 status code if it was able to
fetch all its configured environment documents. If any environment document could not be fetched during a configurable
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.
The Edge Proxy exposes two health check endpoints:

You can point your orchestration health checks to this endpoint.
* `/proxy/health/liveness`: Always responds with a 200 status code. Use this health check to determine if the Edge
Proxy is alive and able to respond to requests.
* `/proxy/health/readiness`: Responds with a 200 status if the Edge Proxy was able to fetch all its configured
environment documents within a configurable grace period. This allows the Edge Proxy to continue reporting as healthy
Comment thread
rolodato marked this conversation as resolved.
even if the Flagsmith API is temporarily unavailable. This health check is also available at `/proxy/health`.

You should point your orchestration health checks to these endpoints.

#### `health_check.environment_update_grace_period_seconds`

Expand Down