NodeTypeNodesHealthEvaluation

  • Article

Represents health evaluation for nodes of a particular node type. The node type nodes evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy node of the included node type that impacted current aggregated health state.

Properties

Name Type Required
AggregatedHealthState string (enum) No
Description string No
NodeTypeName string No
MaxPercentUnhealthyNodes integer No
TotalCount integer (int64) No
UnhealthyEvaluations array of HealthEvaluationWrapper No

AggregatedHealthState

Type: string (enum)
Required: No

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.

Description

Type: string
Required: No

Description of the health evaluation, which represents a summary of the evaluation process.

NodeTypeName

Type: string
Required: No

The node type name as defined in the cluster manifest.

MaxPercentUnhealthyNodes

Type: integer
Required: No

Maximum allowed percentage of unhealthy nodes for the node type, specified as an entry in NodeTypeHealthPolicyMap.

TotalCount

Type: integer (int64)
Required: No

Total number of nodes of the node type found in the health store.

UnhealthyEvaluations

Type: array of HealthEvaluationWrapper
Required: No

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation of this node type that impacted the aggregated health.