package grpc.health.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Health is gRPC's mechanism for checking whether a server is able to handle RPCs. Its semantics are documented in https://github.com/grpc/grpc/blob/master/doc/health-checking.md.

• rpc Check (HealthCheckRequest, HealthCheckResponse)

  health.proto:61

  Check gets the health of the specified service. If the requested service is unknown, the call will fail with status NOT_FOUND. If the caller does not specify a service name, the server should respond with its overall health status. Clients should set a deadline when calling Check, and can declare the server unhealthy if they do not receive a timely response.

• rpc List (HealthListRequest, HealthListResponse)

  health.proto:74

  List provides a non-atomic snapshot of the health of all the available services. The server may respond with a RESOURCE_EXHAUSTED error if too many services exist. Clients should set a deadline when calling List, and can declare the server unhealthy if they do not receive a timely response. Clients should keep in mind that the list of health services exposed by an application can change over the lifetime of the process.

  message HealthListRequest

  health.proto:43

  (message has no fields)

  message HealthListResponse

  health.proto:45

  • map<string, HealthCheckResponse> statuses = 1

    statuses contains all the services and their respective status.

• rpc Watch (HealthCheckRequest, stream HealthCheckResponse)

  health.proto:91

  Performs a watch for the serving status of the requested service. The server will immediately send back a message indicating the current serving status. It will then subsequently send a new message whenever the service's serving status changes. If the requested service is unknown when the call is received, the server will send a message setting the serving status to SERVICE_UNKNOWN but will *not* terminate the call. If at some future point, the serving status of the service becomes known, the server will send a new message with the service's serving status. If the call terminates with status UNIMPLEMENTED, then clients should assume this method is not supported and should not retry the call. If the call terminates with any other status (including OK), clients should retry the call with appropriate exponential backoff.

Used as request type in: Health.Check, Health.Watch

• string service = 1

Used as response type in: Health.Check, Health.Watch

Used as field type in: HealthListResponse

• HealthCheckResponse.ServingStatus status = 1

Used in: HealthCheckResponse

• UNKNOWN = 0

• SERVING = 1

• NOT_SERVING = 2

• SERVICE_UNKNOWN = 3

  Used only by the Watch method.