Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReplicaHealthEvaluation

Package version

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.

Hierarchy

  • ReplicaHealthEvaluation

Index

Properties

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

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

kind

kind: "Replica"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition to which the replica belongs.

Optional replicaOrInstanceId

replicaOrInstanceId: undefined | string

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.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

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

Generated using TypeDoc