Skip to content

Add List method to Health service#2951

Merged
murgatroid99 merged 1 commit intogrpc:masterfrom
MatiasManevi:health_list_js
May 8, 2025
Merged

Add List method to Health service#2951
murgatroid99 merged 1 commit intogrpc:masterfrom
MatiasManevi:health_list_js

Conversation

@MatiasManevi
Copy link
Contributor

@MatiasManevi MatiasManevi commented May 2, 2025

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:

https://cachethq.io/
https://www.atlassian.com/software/statuspage

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

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 2, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

Copy link
Member

@murgatroid99 murgatroid99 left a comment

Choose a reason for hiding this comment

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

Thank you for adding this.

@murgatroid99 murgatroid99 merged commit 21d40b0 into grpc:master May 8, 2025
4 of 5 checks passed
@marcoshuck
Copy link

Thanks for adding these changes, Mati! Happy to work with you 💯

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.

4 participants