PartitionHealth

  • Article

Information about the health of a Service Fabric partition.

Properties

Name Type Required
AggregatedHealthState string (enum) No
HealthEvents array of HealthEvent No
UnhealthyEvaluations array of HealthEvaluationWrapper No
HealthStatistics HealthStatistics No
PartitionId string (uuid) No
ReplicaHealthStates array of ReplicaHealthState No

AggregatedHealthState

Type: string (enum)
Required: No

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.

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.

Possible values are:

  • Invalid - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ok - Indicates the health state is okay. The value is 1.
  • Warning - Indicates the health state is at a warning level. The value is 2.
  • Error - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
  • Unknown - Indicates an unknown health status. The value is 65535.

HealthEvents

Type: array of HealthEvent
Required: No

The list of health events reported on the entity.

UnhealthyEvaluations

Type: array of HealthEvaluationWrapper
Required: No

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

HealthStatistics

Type: HealthStatistics
Required: No

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

PartitionId

Type: string (uuid)
Required: No

ID of the partition whose health information is described by this object.

ReplicaHealthStates

Type: array of ReplicaHealthState
Required: No

The list of replica health states associated with the partition.