Skip to content

Add /healthz endpoint for health monitoring in S3Proxy #763

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

Open
Aazme wants to merge 2 commits into
base: master
Choose a base branch
from
+107 −0
Open

Add /healthz endpoint for health monitoring in S3Proxy #763

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0a1cf7
Add `/healthz` endpoint for basic health check in S3Proxy
Aazme Jan 21, 2025
6b2f492
add git hash to healthz endpoint and introduce tests
Aazme Nov 20, 2025
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
18 changes: 18 additions & 0 deletions src/main/java/org/gaul/s3proxy/S3ProxyHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,12 @@ public final void doHandle(HttpServletRequest baseRequest,
String uri = request.getRequestURI();
String originalUri = request.getRequestURI();

// Check for the /version endpoint
Copy link
Copy Markdown
Owner

@gaul gaul Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove useless comment.

if ("/healthz".equals(uri) && "GET".equalsIgnoreCase(method)) {
handleVersionRequest(response);
return;
}

if (!this.servicePath.isEmpty()) {
if (uri.length() > this.servicePath.length()) {
uri = uri.substring(this.servicePath.length());
Expand Down Expand Up @@ -2029,6 +2035,18 @@ private void handlePutBlob(HttpServletRequest request,

response.addHeader(HttpHeaders.ETAG, maybeQuoteETag(eTag));
}
Copy link
Copy Markdown
Owner

@gaul gaul Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add newline before new method.

private void handleVersionRequest(HttpServletResponse response) throws IOException {
Copy link
Copy Markdown
Owner

@gaul gaul Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be called handleStatuszRequest?

response.setStatus(HttpServletResponse.SC_OK);
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");

String versionInfo = "{ \"status\": \"OK\"}";
Copy link
Copy Markdown
Owner

@gaul gaul Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra space between { and \".

Copy link
Copy Markdown
Owner

@gaul gaul Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?


try (PrintWriter writer = response.getWriter()) {
writer.write(versionInfo);
writer.flush();
}
}

private void handlePostBlob(HttpServletRequest request,
HttpServletResponse response, InputStream is, BlobStore blobStore,
Expand Down