Skip to content

Add List method to gRPC Health service #143

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

Merged
merged 6 commits into from
Mar 26, 2025
Merged

Conversation

marcoshuck
Copy link
Contributor

@marcoshuck marcoshuck commented Feb 12, 2024

Context

Clients cannot get a list of the services a certain server is watching to and their respective status.

In the context of Kubernetes, we have livez and readyz endpoints, by listing all the services a server is checking, we could return a response like the /readyz?verbose Kubernetes API returns:

[+]ping ok
[+]log ok
[+]etcd ok
[+]poststarthook/start-kube-apiserver-admission-initializer ok
[+]poststarthook/generic-apiserver-start-informers ok
[+]poststarthook/start-apiextensions-informers ok
[+]poststarthook/start-apiextensions-controllers ok
[+]poststarthook/crd-informer-synced ok
[+]poststarthook/bootstrap-controller ok
[+]poststarthook/rbac/bootstrap-roles ok
[+]poststarthook/scheduling/bootstrap-system-priority-classes ok
[+]poststarthook/start-cluster-authentication-info-controller ok
[+]poststarthook/start-kube-aggregator-informers ok
[+]poststarthook/apiservice-registration-controller ok
[+]poststarthook/apiservice-status-available-controller ok
[+]poststarthook/kube-apiserver-autoregistration ok
[+]autoregister-completion ok
[+]poststarthook/apiservice-openapi-controller ok
healthz check passed

Use case

This is not only useful for having status reports like Kubernetes readyz endpoints; it also allows services to simplify the set up when creating microservices that publish their status to status page systems such as:

Change

This PR introduces a new List endpoint to the Health service in order to list all the services that a certain server is watching to.

Alternative solution

We could extract the List endpoint into a new service to avoid breaking the v1 API. A new HealthLister (or any other name) must be created.

Proposal

grpc/proposal#468

Copy link

linux-foundation-easycla bot commented Feb 12, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@marcoshuck
Copy link
Contributor Author

Proposal: grpc/proposal#468

@marcoshuck marcoshuck changed the title Add List method to Health service Add List method to gRPC Health service Mar 8, 2025
@marcoshuck marcoshuck requested a review from purnesh42H March 19, 2025 23:08
@dfawley
Copy link
Member

dfawley commented Mar 20, 2025

cc @ejona86 @markdroth

@marcoshuck marcoshuck requested review from markdroth and dfawley March 24, 2025 15:48
Copy link
Member

@dfawley dfawley left a comment

Choose a reason for hiding this comment

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

Looks good, thank you for the changes!

@markdroth
Copy link
Member

@ejona86, please take a look, and then we can get this merged.

@markdroth markdroth merged commit 2eb777a into grpc:master Mar 26, 2025
1 check passed
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 this pull request may close these issues.

6 participants