kaskada.health.health_check_client

Module Contents

Classes

HealthCheckClient

A generic health check client designed to poll the gRPC health check endpoint of a service.

HealthCheckClientFactory

class HealthCheckClient(health_check_endpoint, is_secure)[source]

A generic health check client designed to poll the gRPC health check endpoint of a service.

Parameters:
  • health_check_endpoint (str) –

  • is_secure (bool) –

__del__()[source]

Garbage collector to clean up channel resources

check()[source]

Synchronously checks the health of the server by calling the Check rpc. If the server is not reachable, the result will be UNKNOWN.

Returns:

status reported by the health check

Return type:

health_pb2.HealthCheckResponse.ServingStatus

class HealthCheckClientFactory[source]
get_client(health_check_endpoint, is_secure)[source]
Parameters:
  • health_check_endpoint (str) –

  • is_secure (bool) –

Return type:

HealthCheckClient