ServicesHealthEvaluation

  • Article

Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

Properties

Name Type Required
AggregatedHealthState string (enum) No
Description string No
ServiceTypeName string No
MaxPercentUnhealthyServices 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.

ServiceTypeName

Type: string
Required: No

Name of the service type of the services.

MaxPercentUnhealthyServices

Type: integer
Required: No

Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy.

TotalCount

Type: integer (int64)
Required: No

Total number of services of the current service type in the application from 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 ServiceHealthEvaluation that impacted the aggregated health.