Share via

ClusterHealthChunk

  • Article

Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter.

Properties

Name Type Required
HealthState string (enum) No
NodeHealthStateChunks NodeHealthStateChunkList No
ApplicationHealthStateChunks ApplicationHealthStateChunkList No

HealthState

Type: string (enum)
Required: No

The HealthState representing the aggregated health state of the cluster 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 cluster health policy and the application health policies.

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.

NodeHealthStateChunks

Type: NodeHealthStateChunkList
Required: No

The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description.

ApplicationHealthStateChunks

Type: ApplicationHealthStateChunkList
Required: No

The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description.