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

Support gRPC health check service in VTGate #9333

Closed
shichao-an opened this issue Dec 7, 2021 · 0 comments · Fixed by #9528
Closed

Support gRPC health check service in VTGate #9333

shichao-an opened this issue Dec 7, 2021 · 0 comments · Fixed by #9528
Labels
Type: Enhancement Logical improvement (somewhere between a bug and feature)

Comments

@shichao-an
Copy link
Contributor

shichao-an commented Dec 7, 2021

Feature Description

A written overview of the feature.

Currently the VTGate gRPC server doesn't register the health check service. Here's the output listing services of a VTGate server using grpcurl:

$ ./grpcurl -plaintext  localhost:15991 list
grpc.reflection.v1alpha.ServerReflection
vtgateservice.Vitess

The health check service can be registered like this: https://github.com/vitessio/vitess/blob/main/go/vt/vtadmin/grpcserver/server.go#L138

healthServer := health.NewServer()
healthpb.RegisterHealthServer(gserv, healthServer)

If the gRPC server has health check service registers the grpcurl ls output is like this (using temporal as an example)

grpc.health.v1.Health
grpc.reflection.v1alpha.ServerReflection
temporal.api.workflowservice.v1.WorkflowService
temporal.server.api.adminservice.v1.AdminService

https://github.com/vitessio/vitess/blob/main/go/vt/vtadmin/grpcserver/server.go#L138

Use Case(s)

In our ecosystem we use grpc.health.v1.Health endpoint to check the health of a gRPC server. It optionally takes a service name, such as vtgateservice.Vitess to query for health status.

@aquarapid aquarapid added the Type: Enhancement Logical improvement (somewhere between a bug and feature) label Dec 8, 2021
@vmg vmg closed this as completed in #9528 Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants