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.

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

Clarify that mp.health.default.readiness.empty.response is used only before user readiness checks are processed #283

Closed
xstefank opened this issue Mar 9, 2021 · 1 comment · Fixed by #289
Assignees
Milestone

Comments

@xstefank
Copy link
Member

xstefank commented Mar 9, 2021

The property mp.health.default.readiness.empty.response which defaults to "DOWN" should be taken into account only when user checks are not yet processed. This means that when the runtime knows that the user didn't define any readiness checks then the call to /health/ready should be 200 OK ("UP") and not the value defined by this property.

This could be misinterpreted as the current section collides a little with the Health check procedures section where we state that "A producer with no readiness procedures expected or installed MUST return positive overall status (i.e. HTTP 200)". I made this error in our implementation.

In other words, the order of repeating calls to /health/ready should be 404 -> mp.health.default.readiness.empty.response -> user readiness checks outcome. If the user didn't define any readiness checks then this must be 404 -> mp.health.default.readiness.empty.response (defaults to "DOWN") -> 200 OK (as user didn't define any checks the final status is "UP").

/cc @pgunapal

@pgunapal
Copy link
Contributor

pgunapal commented Mar 9, 2021

Yeah, I agree, we should update the spec to clarify it. When applications are still starting up, we should reflect the mp.health.default.readiness.empty.response status, if its not specified, it should default to DOWN. Once the applications are started, then it should return the user defined readiness checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants