Skip to content
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

Jump to bottom

Override healthcheck HTTP status #1821

Closed
wants to merge 3 commits into from
Closed

Override healthcheck HTTP status #1821

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f31e861
Override healthcheck HTTP status
maffe Mar 23, 2021
ed77499
Merge branch 'release/4.1.x' into patch-1
maffe Apr 12, 2021
92c596e
Merge branch 'release/4.1.x' into patch-1
maffe Apr 14, 2021
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
3 changes: 2 additions & 1 deletion metrics-servlets/src/main/java/com/codahale/metrics/servlets/HealthCheckServlet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ protected void doGet(HttpServletRequest req,
if (results.isEmpty()) {
resp.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED);
maffe marked this conversation as resolved.
Show resolved Hide resolved
} else {
if (isAllHealthy(results)) {
final boolean alwaysOk = Boolean.parseBoolean(req.getParameter("alwaysOk"));
Copy link
Member

Choose a reason for hiding this comment

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

Could we rename the parameter to overrideStatusCode?

The name alwaysOk implies that the health check result would be always healthy. 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Initially I planned to name it similar to your proposal, but then I thought this would suggest the parameter value should be the desired status code (overrideStatusCode=200) instead of a boolean. I included OK because this is the official name for HTTP status 200. Also, I think OK differs from healthy enough to not suggest it would affect those entries.

Maybe httpStatusOk=true?

if (alwaysOk || isAllHealthy(results)) {
resp.setStatus(HttpServletResponse.SC_OK);
} else {
resp.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
Expand Down