Download the PHP package thesis/grpc-health without Composer

thesis/grpc-health

An implementation of the standard gRPC Health Checking Protocol (grpc.health.v1.Health) for thesis/grpc. It ships both sides of the protocol:

• a server — a mutable health state you drive from your application, plus the gRPC service adapter that serves Check, List and Watch from it;
• a client — a thin prober over the generated client that returns a typed ServingStatus, answers serving(), and turns the Watch stream into a callback with a closable handle.

An empty service name ('') always addresses the overall health of the server, as defined by the protocol.

Contents

• Installation
• Server
• Client

Installation

Server

The health state lives in a single Watchdog. Register it once in your container and share it through three narrow ports, each injected only where it is needed:

• Reporter — application services report their own readiness (report());
• Lifecycle — operators drain the whole surface (shutdown() / resume());
• Monitor — the gRPC Server adapter reads statuses and subscribes to changes.

Application services depend on Health\Reporter — they never see gRPC — and report their own readiness:

On shutdown, drain traffic through the Lifecycle: mark everything NOT_SERVING so load balancers stop routing while in-flight work finishes:

In a DI container this is one singleton Watchdog aliased to whichever of Reporter, Lifecycle and Monitor each consumer needs.

Client

Wrap the generated HealthClient to get typed statuses instead of raw protobuf:

watch() runs the Watch server stream in a background coroutine and calls your callback with the current status and then on every change, until the returned handle is closed: