feat: grpc health service #4020
Open
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
Implements gRPC Health check using standard grpc library. Reuses the health as reported by gosundheit health checker. Grpc health server implements also streaming Watch method, so it was necessary to add Stop() failback to stop server even if some clients ignore NOT_SERVING status. Timeout for graceful shutdown was chosen to match timeouts for http and telemetry servers. Signed-off-by: Robert Moucha <[email protected]>
nabokihms
reviewed
Mar 5, 2025
Comment on lines
+519
to
+531
| go func() { | ||
| var status healthgrpc.HealthCheckResponse_ServingStatus | ||
| for { | ||
| switch healthChecker.IsHealthy() { | ||
| case true: | ||
| status = healthgrpc.HealthCheckResponse_SERVING | ||
| default: | ||
| status = healthgrpc.HealthCheckResponse_NOT_SERVING | ||
| } | ||
| healthcheck.SetServingStatus("", status) | ||
| time.Sleep(healthCheckPeriod) | ||
| } | ||
| }() |
There was a problem hiding this comment.
Could ae avoid using goroutines in goroutines here and use a separate group for the health endpoint?
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.
Overview
Implements gRPC Health check using standard grpc library.
Reuses the health as reported by gosundheit health checker. Grpc health server
implements also streaming Watch method, so it was necessary to add
Stop() failback to stop server even if some clients ignore NOT_SERVING
status. Timeout for graceful shutdown was chosen to match timeouts for
http and telemetry servers.
What this PR does / why we need it
Dex already provides health check endpoint via HTTP. For integrations based on
gRPC, notably if we want to use client-side health checks for higher reliability,
as described here, we also need
to report service health using
grpc.health.v1.Healthservice.Special notes for your reviewer
Golang is not my mother tongue, so if there is something utterly wrong, please let me
know.