EventHealthEvaluation

  • Article

Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning.

Properties

Name Type Required
AggregatedHealthState string (enum) No
Description string No
ConsiderWarningAsError boolean No
UnhealthyEvent HealthEvent 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.

ConsiderWarningAsError

Type: boolean
Required: No

Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity.

UnhealthyEvent

Type: HealthEvent
Required: No

Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.