health_check#

Wrapper over the health check gRPC service of Fluent.

Classes:

HealthCheckService(channel, metadata, ...)

Class wrapping the health check gRPC service of Fluent.
class ansys.fluent.core.services.health_check.HealthCheckService(channel, metadata, fluent_error_state)#

Bases: object

Class wrapping the health check gRPC service of Fluent.

Methods

check_health()

Check the health of the Fluent connection.

Classes:

Status(value[, names, module, qualname, ...])

Health check status.

Methods:

__init__(channel, metadata, fluent_error_state)

__init__ method of HealthCheckService class.

check_health()

Check the health of the Fluent connection.

status()

Check health of Fluent connection.

wait_for_server(timeout)

Keeps a watch on the health of the Fluent connection.

Attributes:

is_serving

Checks whether Fluent is serving.
class Status(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Health check status.

Attributes:

NOT_SERVING

SERVICE_UNKNOWN

SERVING

UNKNOWN

NOT_SERVING: int = 2#
SERVICE_UNKNOWN: int = 3#
SERVING: int = 1#
UNKNOWN: int = 0#
__init__(channel, metadata, fluent_error_state)#

__init__ method of HealthCheckService class.

check_health()#

Check the health of the Fluent connection.

Returns:
str

“SERVING” or “NOT_SERVING”

property is_serving: bool#

Checks whether Fluent is serving.

status()#

Check health of Fluent connection.

wait_for_server(timeout)#

Keeps a watch on the health of the Fluent connection.

Response changes only when the service’s serving status changes.

Parameters:
timeoutint

timeout in seconds

Raises:
TimeoutError

If the connection to the Fluent server could not be established within the timeout.