Skip to content

health: Add List method to gRPC Health service #8155

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
May 9, 2025
Merged

health: Add List method to gRPC Health service #8155

merged 13 commits into from
May 9, 2025

Conversation

marcoshuck
Copy link
Contributor

@marcoshuck marcoshuck commented Mar 8, 2025 •
edited by purnesh42H
Loading

This change introduces a new List RPC endpoint for the Health service, allowing clients to retrieve the statuses of all monitored services. This feature simplifies integration with status-reporting dashboards and enhances observability for microservices.

Proposal: grpc/proposal#468
gRPC-proto change: grpc/grpc-proto#143

RELEASE NOTES:

  • health: added List method to gRPC Health service.

@marcoshuck
Add List method to gRPC Health service
31b32ef 
This change introduces a new `List` RPC endpoint for the Health service, allowing clients to retrieve the statuses of all monitored services. This feature simplifies integration with status-reporting dashboards and enhances observability for microservices.

Proposal: grpc/proposal#468
gRPC-proto change: grpc/grpc-proto#143
Signed-off-by: Marcos Huck <marcos@huck.com.ar>
marcoshuck
marcoshuck commented Mar 8, 2025
View reviewed changes
health/grpc_health_v1/health.pb.go Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I regenerated the Go stubs using the work in progress version of grpc/grpc-proto#143

marcoshuck
marcoshuck commented Mar 8, 2025
View reviewed changes
health/grpc_health_v1/health_grpc.pb.go Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I regenerated the Go stubs using the work in progress version of grpc/grpc-proto#143

@codecov Codecov
Copy link

codecov bot commented Mar 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.15%. Comparing base (4cedec4) to head (8ea3d54).
Report is 18 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #8155      +/-   ##
==========================================
+ Coverage   82.08%   82.15%   +0.06%     
==========================================
  Files         417      419       +2     
  Lines       41344    41988     +644     
==========================================
+ Hits        33936    34494     +558     
- Misses       5972     6023      +51     
- Partials     1436     1471      +35
Files with missing lines Coverage Δ
health/server.go 95.65% <100.00%> (+0.65%) ⬆️

... and 52 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

purnesh42H
purnesh42H reviewed Mar 10, 2025
View reviewed changes
Copy link
Contributor

@purnesh42H purnesh42H left a comment

Choose a reason for hiding this comment

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

@marcoshuck i think we need to wait for the proposal and proto change to be merged before this? I still see them in review

@dfawley cc

@purnesh42H purnesh42H added Area: Observability Includes Stats, Tracing, Channelz, Healthz, Binlog, Reflection, Admin, GCP Observability Type: Feature New features or improvements in behavior Status: Requires Reporter Clarification labels Mar 10, 2025
@marcoshuck marcoshuck mentioned this pull request Mar 10, 2025
Merged
@marcoshuck
Address comments from code review
23a4f3a 
Signed-off-by: Marcos Huck <marcos@huck.com.ar>
@github-actions GitHub Actions
Copy link

This PR is labeled as requiring an update from the reporter, and no update has been received after 6 days. If no update is provided in the next 7 days, this issue will be automatically closed.

@github-actions github-actions bot added the stale label Mar 19, 2025
@marcoshuck marcoshuck requested a review from purnesh42H March 19, 2025 23:07
@github-actions github-actions bot removed the stale label Mar 20, 2025
@dfawley dfawley assigned purnesh42H and unassigned marcoshuck Mar 20, 2025
@dfawley dfawley added Area: Observability Includes Stats, Tracing, Channelz, Healthz, Binlog, Reflection, Admin, GCP Observability and removed Area: Observability Includes Stats, Tracing, Channelz, Healthz, Binlog, Reflection, Admin, GCP Observability labels Mar 20, 2025
purnesh42H
purnesh42H reviewed Mar 24, 2025
View reviewed changes
@purnesh42H purnesh42H assigned marcoshuck and unassigned purnesh42H Mar 24, 2025
marcoshuck and others added 3 commits March 24, 2025 12:54
@marcoshuck
Address comments from code review
6e62ea4 
Signed-off-by: Marcos Huck <marcos@huck.com.ar>
@marcoshuck @purnesh42H
Apply suggestions from code review
500bc52 
Co-authored-by: Purnesh Dixit <purnesh.dixit92@gmail.com>
@marcoshuck
Fix Fatalf usage
174617c 
Signed-off-by: Marcos Huck <marcos@huck.com.ar>
@marcoshuck marcoshuck requested a review from purnesh42H March 24, 2025 15:57
@purnesh42H
Copy link
Contributor

@marcoshuck could you resolve the merge conflicts?

purnesh42H
purnesh42H reviewed Mar 28, 2025
View reviewed changes
@github-actions github-actions bot added the stale label Apr 22, 2025
@marcoshuck
Copy link
Contributor Author

Could you run ./scripts/vet.sh to catch vet errors and fix them?

I did, however I cannot find the root cause for the vet error, any advice?

@github-actions github-actions bot removed the stale label Apr 27, 2025
@purnesh42H purnesh42H added this to the 1.73 Release milestone Apr 28, 2025
@arjan-bal
Copy link
Contributor

arjan-bal commented Apr 28, 2025 •
edited
Loading

Could you run ./scripts/vet.sh to catch vet errors and fix them?

I did, however I cannot find the root cause for the vet error, any advice?

goimports -l . is reporting that the imports in health/server_internal_test.go need to be formatted. You should be able to fix it using the following command:

goimports -w ./health/server_internal_test.go

dfawley
dfawley reviewed Apr 28, 2025
View reviewed changes
@marcoshuck
Copy link
Contributor Author

Could you run ./scripts/vet.sh to catch vet errors and fix them?

I did, however I cannot find the root cause for the vet error, any advice?

goimports -l . is reporting that the imports in health/server_internal_test.go need to be formatted. You should be able to fix it using the following command:

goimports -w ./health/server_internal_test.go

That did the trick, thank you!

@dfawley
Copy link
Member

dfawley commented Apr 28, 2025

Filed #8276 for the flake. And we can ignore the vet-proto error - we need to regenerate our proto messages, but not in this PR.

dfawley
dfawley approved these changes Apr 28, 2025
View reviewed changes
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.

LGTM, thanks!

purnesh42H
purnesh42H reviewed Apr 29, 2025
View reviewed changes
health/server_internal_test.go Outdated
}

// TestListResourceExhausted verifies that List(
// ) returns a ResourceExhausted error if no. of services are more than
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: move the dangling bracket above

@purnesh42H
Copy link
Contributor

@marcoshuck 2 more small comments. Thanks.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 5, 2025

This PR is labeled as requiring an update from the reporter, and no update has been received after 6 days. If no update is provided in the next 7 days, this issue will be automatically closed.

@github-actions github-actions bot added stale and removed stale labels May 5, 2025
marcoshuck
marcoshuck commented May 9, 2025
View reviewed changes
@arjan-bal arjan-bal assigned arjan-bal and unassigned marcoshuck May 9, 2025
@arjan-bal arjan-bal changed the title Add List method to gRPC Health service health: Add List method to gRPC Health service May 9, 2025
@arjan-bal arjan-bal merged commit 950a7cf into grpc:master May 9, 2025
23 of 24 checks passed
@dims dims mentioned this pull request May 18, 2025
Merged
vinothkumarr227 pushed a commit to vinothkumarr227/grpc-go that referenced this pull request May 26, 2025
@marcoshuck @vinothkumarr227
health: Add List method to gRPC Health service (grpc#8155)
e54e81b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dfawley dfawley dfawley approved these changes

+1 more reviewer

@purnesh42H purnesh42H purnesh42H approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@arjan-bal arjan-bal

Labels
Area: Observability Includes Stats, Tracing, Channelz, Healthz, Binlog, Reflection, Admin, GCP Observability Type: Feature New features or improvements in behavior
Projects
None yet
Milestone
1.73 Release
Development

Successfully merging this pull request may close these issues.
4 participants
@marcoshuck @purnesh42H @arjan-bal @dfawley