Share via

ClusterHealthChunkQueryDescription

  • Article

The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.

Properties

Name Type Required
NodeFilters array of NodeHealthStateFilter No
ApplicationFilters array of ApplicationHealthStateFilter No
ClusterHealthPolicy ClusterHealthPolicy No
ApplicationHealthPolicies ApplicationHealthPolicies No

NodeFilters

Type: array of NodeHealthStateFilter
Required: No

Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.

ApplicationFilters

Type: array of ApplicationHealthStateFilter
Required: No

Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.

ClusterHealthPolicy

Type: ClusterHealthPolicy
Required: No

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

ApplicationHealthPolicies

Type: ApplicationHealthPolicies
Required: No

Defines the application health policy map used to evaluate the health of an application or one of its children entities.