System.Fabric.Health Namespace

Contains classes that support managing the health of Service Fabric applications.

Classes

ApplicationHealth

Describes the health of an application as returned by GetApplicationHealthAsync(ApplicationHealthQueryDescription).

ApplicationHealthEvaluation

Represents health evaluation for an application, containing information about the data and the algorithm used by health store to evaluate health.

ApplicationHealthPolicy

Defines a health policy used to evaluate the health of a Service Fabric application or one of its children entities.

ApplicationHealthPolicyMap

Represents a map that contains specific application health policies for different applications.

ApplicationHealthReport

Represents a health report to be applied on an application health entity.

ApplicationHealthState

Represents the health state of an application, which contains the application identifier and the aggregated health state.

ApplicationHealthStateChunk

Represents an application health state chunk, which contains basic health information about the application.

ApplicationHealthStateChunkList

Represents a list that contains ApplicationHealthStateChunk items.

ApplicationHealthStateFilter

Filter for ApplicationHealthState objects.

ApplicationHealthStateList

Represents a collection of ApplicationHealthState that can be individually accessed by index.

ApplicationHealthStatesFilter

Provides filter for ApplicationHealthState objects.

ApplicationHealthStatisticsFilter

Represents the filter for HealthStatistics.

ApplicationsHealthEvaluation

Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.

ApplicationTypeApplicationsHealthEvaluation

Represents health evaluation for applications of an application type.

ApplicationTypeHealthPolicyMap

Defines a map with max percentages unhealthy applications for specific application types.

ClusterHealth

Represents the health of the cluster, as returned by GetClusterHealthAsync(ClusterHealthQueryDescription). Contains the cluster aggregated health state, the application health states, the node health states as well as health events, health evaluation, and health statistics.

ClusterHealthChunk

Represents the cluster state chunk, which includes health information about the cluster.

ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

ClusterHealthReport

Represents a health report to be applied on the cluster health entity.

ClusterHealthStatisticsFilter

Represents the filter for HealthStatistics.

ClusterUpgradeHealthPolicy

Defines a health policy used to evaluate the health of the cluster specific to cluster upgrade.

DeltaNodesCheckHealthEvaluation

Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Error.

DeployedApplicationHealth

Describes the health of an application deployed on a node as returned by GetDeployedApplicationHealthAsync(DeployedApplicationHealthQueryDescription).

DeployedApplicationHealthEvaluation

Represents health evaluation for a deployed application, containing information about the data and the algorithm used by health store to evaluate health.

DeployedApplicationHealthReport

Represents a health report to be applied on the deployed application health entity.

DeployedApplicationHealthState

Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.

DeployedApplicationHealthStateChunk

Represents a deployed application health state chunk, which contains basic health information about the deployed application. It is included as child of an application.

DeployedApplicationHealthStateChunkList

Represents a list that contains DeployedApplicationHealthStateChunk items.

DeployedApplicationHealthStateFilter

Filter for DeployedApplicationHealthState objects.

DeployedApplicationHealthStateList

Represents a collection of DeployedApplicationHealthState that can be individually accessed by index.

DeployedApplicationHealthStatesFilter

Represents the filter for DeployedApplicationHealthState objects.

DeployedApplicationHealthStatisticsFilter

Represents the filter for HealthStatistics.

DeployedApplicationsHealthEvaluation

Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

DeployedServicePackageHealth

Describes the health of a deployed service package as returned by GetDeployedServicePackageHealthAsync(DeployedServicePackageHealthQueryDescription).

DeployedServicePackageHealthEvaluation

Represents health evaluation for a deployed service package, 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.

DeployedServicePackageHealthReport

Represents a health report to be applied on the deployed service package health entity.

DeployedServicePackageHealthState

Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.

DeployedServicePackageHealthStateChunk

Represents a deployed service package health state chunk, which contains basic health information about the deployed service package. It is included as child of a deployed application.

DeployedServicePackageHealthStateChunkList

Represents a list that contains DeployedServicePackageHealthStateChunk items.

DeployedServicePackageHealthStateFilter

Filter for DeployedServicePackageHealthState objects.

DeployedServicePackageHealthStateList

Represents a collection of DeployedServicePackageHealthState that can be individually accessed by index.

DeployedServicePackageHealthStatesFilter

Represents the filter for DeployedServicePackageHealthState objects.

DeployedServicePackagesHealthEvaluation

Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.

EntityHealth

Represents the base class for all entity health related classes.

EntityHealthState

Represents the base class for all entity health state classes.

EntityKindHealthStateCount

Represents health state count for entities of the specified entity kind. It is returned as part of health statistics when requested by the health queries.

EventHealthEvaluation

Represents health evaluation of a HealthEvent. Can be returned when evaluating health of an entity returns Error or Warning.

HealthEvaluation

Represents a health evaluation which describes the data and the algorithm used by health store to evaluate the health of an entity.

HealthEvent

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

HealthEventsFilter

Represents the filter for HealthEvent objects.

HealthInformation

Represents common health report information. It is included in all health reports sent to the health store and in all health events returned by health queries.

HealthReport

Represents a base class for health report classes.

HealthReportSendOptions

Represents the send options that are applied when sending a HealthReport.

HealthStateChunkList<T>

Represents a chunk list that contains a list of health state chunk items.

HealthStateChunkListHelper

Extensions for health state chunk list operations.

HealthStateCount

Represents information about how many health entities are in Ok, Warning, and Error state.

HealthStatistics

Represents health statistics for an entity. It is returned as part of health queries results when the query descriptions are configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.

NodeHealth

Describes the health of a node as returned by GetNodeHealthAsync(NodeHealthQueryDescription).

NodeHealthEvaluation

Represents health evaluation for a node, 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.

NodeHealthReport

Represents a health report to be applied on the node health entity. The report is sent to health store with ReportHealth(HealthReport).

NodeHealthState

Represents the health state of a node, which contains the node identifier and its aggregated health state.

NodeHealthStateChunk

Represents a node health state chunk, which contains basic health information about the node.

NodeHealthStateChunkList

Represents a list that contains NodeHealthStateChunk items.

NodeHealthStateFilter

Filter for NodeHealthState objects.

NodeHealthStateList

Represents a collection of NodeHealthState that can be individually accessed by index.

NodeHealthStatesFilter

Represents the filter for NodeHealthState objects.

NodesHealthEvaluation

Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.

PartitionHealth

Describes health of a partition as returned by GetPartitionHealthAsync(PartitionHealthQueryDescription).

PartitionHealthEvaluation

Represents health evaluation for a partition, 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.

PartitionHealthReport

Represents a health report to be applied on a partition health entity. The report is sent to health store with ReportHealth(HealthReport).

PartitionHealthState

Represents the health state of a partition, which contains the partition identifier and its aggregated health state.

PartitionHealthStateChunk

Represents a partition health state chunk, which contains basic health information about the partition.

PartitionHealthStateChunkList

Represents a list that contains PartitionHealthStateChunk items.

PartitionHealthStateFilter

Filter for PartitionHealthState objects.

PartitionHealthStateList

Represents a collection of PartitionHealthState that can be individually accessed by index.

PartitionHealthStatesFilter

Represents the filter for PartitionHealthState objects.

PartitionHealthStatisticsFilter

Represents the filter for HealthStatistics.

PartitionsHealthEvaluation

Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.

ReplicaHealth

Describes the health of a stateful service replica or a stateless service instance as returned by GetReplicaHealthAsync(ReplicaHealthQueryDescription).

ReplicaHealthEvaluation

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.

ReplicaHealthState

Represents a base class for stateful service replica or stateless service instance health state.

ReplicaHealthStateChunk

Represents a replica health state chunk, which contains basic health information about the replica. It is included as child of a partition.

ReplicaHealthStateChunkList

Represents a list that contains ReplicaHealthStateChunk items.

ReplicaHealthStateFilter

Filter for ReplicaHealthState objects.

ReplicaHealthStateList

Represents a collection of ReplicaHealthState that can be individually accessed by index.

ReplicaHealthStatesFilter

Represents the filter for ReplicaHealthState objects.

ReplicasHealthEvaluation

Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.

ServiceHealth

Describes the health of a service as returned by GetServiceHealthAsync(ServiceHealthQueryDescription).

ServiceHealthEvaluation

Represents health evaluation for a service, 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.

ServiceHealthReport

Represents a health report to be applied on a service health entity. The report is sent to health store with ReportHealth(HealthReport).

ServiceHealthState

Represents the health state of a service, which contains the service identifier and its aggregated health state.

ServiceHealthStateChunk

Represents a service health state chunk, which contains basic health information about the service.

ServiceHealthStateChunkList

Represents a list that contains ServiceHealthStateChunk items.

ServiceHealthStateFilter

Filter for ServiceHealthState objects.

ServiceHealthStateList

Represents a collection of ServiceHealthState that can be individually accessed by index.

ServiceHealthStatesFilter

Represents filter for ServiceHealthState objects.

ServiceHealthStatisticsFilter

Represents the filter for HealthStatistics.

ServicesHealthEvaluation

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.

ServiceTypeHealthPolicy

Represents the health policy used to evaluate the health of services belonging to a service type.

StatefulServiceReplicaHealth

Describes the health of a stateful service replica as returned by GetReplicaHealthAsync(ReplicaHealthQueryDescription).

StatefulServiceReplicaHealthReport

Represents a health report to be applied on a stateful service replica health entity. The report is sent to health store with ReportHealth(HealthReport).

StatefulServiceReplicaHealthState

Represents the health state of the stateful service replica, which contains the replica is and the aggregated health state.

StatelessServiceInstanceHealth

Describes the health of the stateless instance as returned by GetReplicaHealthAsync(ReplicaHealthQueryDescription).

StatelessServiceInstanceHealthReport

Represents a health report to be applied on a stateless service health entity. The report is sent to health store with ReportHealth(HealthReport).

StatelessServiceInstanceHealthState

Represents the health state of a stateless service instance health entity, which contains the instance id and the aggregated health state.

SystemApplicationHealthEvaluation

Represents health evaluation for the fabric:/System application, 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 of the cluster is either Error or Warning.

UpgradeDomainDeltaNodesCheckHealthEvaluation

Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Error.

UpgradeDomainDeployedApplicationsHealthEvaluation

Represents health evaluation for deployed applications of an application in an upgrade domain, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.

UpgradeDomainNodesHealthEvaluation

Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.

Enums

EntityKind

Represents the entity kind.

HealthEvaluationKind

Enumerates the kinds of health evaluation.

HealthReportKind

Represents the health report kind.

HealthState

Represents the health state.

HealthStateFilter

Enumerates filters for parameters of type HealthState. This enumeration has a FlagsAttribute that allows a bitwise combination of its member values.