docs: edge proxy health check configuration#4580
Conversation
matthewelwell
requested review from
agregoryfs
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
matthewelwell
requested review from
rolodato
and removed request for
agregoryfs
| "count_stale_documents_as_failing": true, | ||
| "grace_period_seconds": 30 |
There was a problem hiding this comment.
Are these the new defaults? Looking at https://github.com/Flagsmith/edge-proxy/pull/122/files#diff-4573c040951bc5c2676139dcf260c4a96b0f9b830f15227322c0a1f8545da004R104-R105
In which case these docs should mention how to change the defaults, only if needed
| ### `config.json` example | ||
| ### Health Check | ||
|
|
||
| The health check can be configured depending on the use case for the Edge Proxy by adding the `health_check` object to |
There was a problem hiding this comment.
Suggest using active voice instead of passive voice https://developers.google.com/style/voice, and clarifying what the default behaviour is. Something like this:
The Edge Proxy exposes a health check endpoint at `/proxy/health` that responds with a 200 status code if was able to fetch all its configured environment documents. If any environment document could not be fetched during the latest poll, it will respond with a 500 status code.
In some cases, you may want the Edge Proxy to succeed its health checks even if it failed to fetch any environment document, but only if it these documents were successfully fetched at some point in the past. You can achieve this by...
(I was typing this suggestion until I saw this: https://github.com/Flagsmith/flagsmith/pull/4580/files#r1743739010 - this would need to be changed depending on what the new defaults are)
There was a problem hiding this comment.
Good feedback, thanks. I've updated the PR with changes that (I think) resolve both of your comments.
2 participants
Changes
The main purpose of this PR is to add the corresponding documentation for this edge proxy PR.
I have also slightly tweaked the formatting of the documentation (although it could still use some finessing at some point).
How did you test this code?
Ran the docs locally and verified the changes.