Return grpc serving status in health check errors #8726
Merged
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
|
|
pierresouchay
suggested changes
Sep 24, 2020
| if response == nil || response.Status != hv1.HealthCheckResponse_SERVING { | ||
| return ErrGRPCUnhealthy | ||
| if response.Status != hv1.HealthCheckResponse_SERVING { | ||
| return fmt.Errorf("gRPC %s serving status: %s", target, response.Status) |
There was a problem hiding this comment.
response.Status is an int, might be improved:
statusTxt, ok := hv1.HealthCheckResponse_ServingStatus_name[response.Status]
if !ok {
statusTxt = fmt.Sprintf("UnexpectedGRPCStatus:=%d", response.Status)
}
return fmt.Errorf("gRPC Error: %s for target %s", statusTxt, target)There was a problem hiding this comment.
response.Status already has String method, that's why I put %s there.
func (m *HealthCheckResponse) String() string { return proto.CompactTextString(m) }
e.g. grpc_health_v1.HealthCheckResponse_NOT_SERVING.String() produces NOT_SERVING
There was a problem hiding this comment.
I think UnexpectedGRPCStatus can confuse people with general gRPC status codes.
dnephin
added
theme/health-checks
dnephin
approved these changes
Sep 25, 2020
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.
Hi there!
This PR adds serving status to gRPC health check errors, because sometimes it's not clear what causes a failure,
SERVICE_UNKNOWNdue to misconfiguration orNOT_SERVINGwhen a service is shutting down.