ReplicaHealthEvaluation

  • Article

Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Properties

Name Type Required
AggregatedHealthState string (enum) No
Description string No
PartitionId string (uuid) No
ReplicaOrInstanceId string 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.

PartitionId

Type: string (uuid)
Required: No

Id of the partition to which the replica belongs.

ReplicaOrInstanceId

Type: string
Required: No

Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.

UnhealthyEvaluations

Type: array of HealthEvaluationWrapper
Required: No

List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation.