EntityHealth Class

Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.

Inheritance

Model

EntityHealth

Constructor

EntityHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, **kwargs)

Parameters

aggregated_health_state

str or HealthState

Required

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

health_events

list[HealthEvent]

Required

The list of health events reported on the entity.

unhealthy_evaluations

list[HealthEvaluationWrapper]

Required

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

health_statistics

HealthStatistics

Required

Shows the health statistics for all children types of the queried entity.