in_http: add configurable health endpoint #10441
Open
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
This PR adds the /health endpoint that works through the GET method so remote
clients can check if the http service is up or not.
When accessed, it returns a JSON response like this:
{
"status": "ok",
"message": "I can only show you the door. You're the one that has to walk through it.",
"timestamp": "2025-02-27T03:15:42.477701772Z"
}
Signed-off-by: Eduardo Silva <[email protected]>
Add optional health endpoint accessible via GET /health when enabled. The endpoint returns JSON with status, version, git hash and timestamp instead of the original Matrix movie quote. The endpoint is disabled by default for security. The health_check configuration directive enables the endpoint: health_check true Fixes #10003 Supersedes PR #10020
niedbalski
requested review from
edsiper,
leonardo-albertovich,
fujimotos and
koleini
as code owners
niedbalski
force-pushed
the
in_http_health_v2
branch
from
e2af9c8 to
cf6dd78
Compare
Add tests for the new health endpoint functionality: - health_endpoint: tests enabled health check returns 200 with JSON - health_endpoint_disabled: tests disabled health check returns 400 The tests verify the health_check configuration directive works correctly and that JSON response contains expected fields.
niedbalski
force-pushed
the
in_http_health_v2
branch
from
cf6dd78 to
489a1a9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add optional health endpoint accessible via GET /health when enabled.
The endpoint returns JSON with status, version, git hash and timestamp. Please note that this endpoint is disabled by default.
The health_check configuration directive enables the endpoint:
When enabled, GET /health returns:
{ "status": "ok", "version": "4.0.0", "git_hash": "9e84b08f0b69bf27d3307c31e08de90b4395f5e1", "timestamp": "2025-06-05T15:43:17.398269000Z" }Fixes #10003
Supersedes PR #10020