Provide a grpc.health.v1 health checking service
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- backend-api-design
Research direction
Read ServerReflection as the proposed model and server/kubernetes.md for the existing health-check documentation. Then review how server services and Scala/Java APIs are exposed; the issue identifies no implementation files or tests. Done means providing grpc.health.v1.Health with Check, Watch, per-service and overall status controls, plus server setup and Kubernetes probe documentation.
Written by the indexing model from the issue text.
Description
Pekko gRPC has no built-in implementation of the standard gRPC health checking service, grpc.health.v1.Health (https://github.com/grpc/grpc/blob/master/doc/health-checking.md). server/kubernetes.md only describes HTTP health checks.
Kubernetes gRPC liveness/readiness probes, grpc-health-probe, Envoy and other load balancers expect this service. grpc-java provides HealthStatusManager.
Proposal:
- Provide a
grpc.health.v1service implementation with Scala and Java APIs, likeServerReflection. - Support
CheckandWatch, and a way to set the serving status per service (and for the empty overall service name). - Document how to add it to a server, and how to use it with Kubernetes gRPC probes.
- Dominant language
- Scala
- Stars
- 55
- Forks
- 30
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/pekko-grpc
-
Difficulty 4/5 3-5 days Newbie friendliness 43/100
apache/pekko-grpc#933 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
apache/pekko-grpc#932 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
apache/pekko-grpc#931 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 46/100
apache/pekko-grpc#929 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
apache/pekko-grpc#928 ·
Maintainers usually reply within 1 day
All issues in apache/pekko-grpc
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
canton-network/splice#8087 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 73/100
lichess-org/lila#22298 ·
Maintainers usually reply within 1 day
-
Task 🔧
Difficulty 1/5 Under an hour Newbie friendliness 88/100
valkey-io/valkey-glide#7455 ·
Maintainers usually reply within 1 day