Add /healthz endpoint for health monitoring in S3Proxy #763
Conversation
This file contains 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
- Implemented a new `/healthz` endpoint to handle GET requests.
- Added the `handleVersionRequest` method to return a JSON response with health status:
- Response: `{ "status": "OK" }`
- Updated `S3ProxyHandler` to route requests to `/healthz` and handle responses effectively.
- The endpoint provides a simple mechanism for health monitoring and status validation.
Aazme
changed the title
gaul
requested changes
Jan 21, 2025
There was a problem hiding this comment.
Please address Checkstyle warnings:
Warning: src/main/java/org/gaul/s3proxy/S3ProxyHandler.java:[2042] (regexp) RegexpSingleline: Line has trailing spaces.
Warning: src/main/java/org/gaul/s3proxy/S3ProxyHandler.java:[2044] (regexp) RegexpSingleline: Line has trailing spaces.
| @@ -2029,6 +2035,18 @@ private void handlePutBlob(HttpServletRequest request, | |||
|
|
|||
| response.addHeader(HttpHeaders.ETAG, maybeQuoteETag(eTag)); | |||
| } | |||
| private void handleVersionRequest(HttpServletResponse response) throws IOException { | |||
There was a problem hiding this comment.
Should this be called handleStatuszRequest?
| response.setContentType("application/json"); | ||
| response.setCharacterEncoding("UTF-8"); | ||
|
|
||
| String versionInfo = "{ \"status\": \"OK\"}"; |
There was a problem hiding this comment.
Maybe this should return the current time, the time s3proxy launched, and the git hash? Are there any well-known statusz formats this could follow?
| @@ -2029,6 +2035,18 @@ private void handlePutBlob(HttpServletRequest request, | |||
|
|
|||
| response.addHeader(HttpHeaders.ETAG, maybeQuoteETag(eTag)); | |||
| } | |||
| @@ -293,6 +293,12 @@ public final void doHandle(HttpServletRequest baseRequest, | |||
| String uri = request.getRequestURI(); | |||
| String originalUri = request.getRequestURI(); | |||
|
|
|||
| // Check for the /version endpoint | |||
gaul
requested changes
Jan 21, 2025
| response.setContentType("application/json"); | ||
| response.setCharacterEncoding("UTF-8"); | ||
|
|
||
| String versionInfo = "{ \"status\": \"OK\"}"; |
There was a problem hiding this comment.
Maybe this should return the current time, the time s3proxy launched, and the git hash? Are there any well-known statusz formats this could follow?
|
I'm preparing a new release so please try to address my comments before the weekend. |
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.
This PR introduces a new /healthz endpoint in S3Proxy to provide a basic health check mechanism.
Changes:
Added a /healthz route to handle GET requests.
Implemented handleVersionRequest method to return a JSON response:
{ "status": "OK" }Updated S3ProxyHandler to route and process health check requests.
This endpoint serves as a lightweight solution for monitoring the service's availability.