docs: add health check configuration #1993
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
fix pre-commit
alexandreLamarre
force-pushed
the
health-checks
branch
from
56f7ff7 to
0613fc0
Compare
alexandreLamarre
requested review from
kenjenkins
and removed request for
a team
rjbeers
requested changes
Sep 25, 2025
|
|
||
| In Pomerium, these health checks will report on the status of: | ||
|
|
||
| - Readiness and health of the embedded envoy instance |
There was a problem hiding this comment.
Suggested change
| - Readiness and health of the embedded envoy instance | |
| - Readiness and health of the embedded Envoy instance |
|
|
||
| ### Liveness | ||
|
|
||
| The `/healthz` endpoint |
There was a problem hiding this comment.
Looks like I accidentally git stashed those changes.
|
|
||
| ### Filters | ||
|
|
||
| Unlike HTTP probes, the CLI provides additional flexibility through exclude filters, which let you ignore specific internal conditions reported by Pomerium when evaluating health. |
There was a problem hiding this comment.
How about adding a check definition section with short descriptions of what each of these checks covers, so they can figure out what they might want to filter out?
There was a problem hiding this comment.
Yeah probably a good idea to do that, although they're internal checks so may not make intuitive sense to users, so let me take some time to think about the best way to document those
rjbeers
approved these changes
Sep 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ENG-2290