Health¶

class consulate.api.health.Health(uri, adapter, datacenter=None, token=None)¶

Used to query health related information. It is provided separately from the Catalog, since users may prefer to not use the health checking mechanisms as they are totally optional. Additionally, some of the query results from the Health system are filtered, while the Catalog endpoints provide the raw entries.

checks(service_id)¶

Return checks for the given service.

Parameters:	service_id (str) – The service ID
Return type:	list

node(node_id)¶

Return the health info for a given node.

Parameters:	node_id (str) – The node ID
Return type:	list

service(service_id, tag=None, passing=None)¶

Returns the nodes and health info of a service

Parameters:	service_id (str) – The service ID
Return type:	list

state(state)¶

Returns the checks in a given state where state is one of “unknown”, “passing”, “warning”, or “critical”.

Parameters:	state (str) – The state to get checks for
Return type:	list