Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation.shards

Class ShardsAvailabilityHealthIndicatorService

java.lang.Object

org.elasticsearch.cluster.routing.allocation.shards.ShardsAvailabilityHealthIndicatorService

All Implemented Interfaces:

HealthIndicatorService

Direct Known Subclasses:

StatefulShardsAvailabilityHealthIndicatorService

public abstract class ShardsAvailabilityHealthIndicatorService
extends Object
implements HealthIndicatorService

This is the parent class for shard health indicators. The reported status will depend on whether we are running in stateless or stateful mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShardsAvailabilityHealthIndicatorService.SearchableSnapshotsState
class	ShardsAvailabilityHealthIndicatorService.ShardAllocationCounts
class	ShardsAvailabilityHealthIndicatorService.ShardAllocationStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final Diagnosis.Definition	ACTION_CHECK_ALLOCATION_EXPLAIN_API
static final Diagnosis.Definition	ACTION_ENABLE_CLUSTER_ROUTING_ALLOCATION
static final Diagnosis.Definition	ACTION_ENABLE_INDEX_ROUTING_ALLOCATION
static final Diagnosis.Definition	ACTION_INCREASE_NODE_CAPACITY
static final Diagnosis.Definition	ACTION_INCREASE_SHARD_LIMIT_CLUSTER_SETTING
static final Diagnosis.Definition	ACTION_INCREASE_SHARD_LIMIT_INDEX_SETTING
static final Diagnosis.Definition	ACTION_RESTORE_FROM_SNAPSHOT
protected final ClusterService	clusterService
static final String	DIAGNOSE_SHARDS_ACTION_GUIDE
static final Diagnosis.Definition	DIAGNOSIS_WAIT_FOR_INITIALIZATION
static final Diagnosis.Definition	DIAGNOSIS_WAIT_FOR_OR_FIX_DELAYED_SHARDS
static final String	ENABLE_CLUSTER_ALLOCATION_ACTION_GUIDE
static final String	ENABLE_INDEX_ALLOCATION_GUIDE
static final String	ENABLE_TIER_ACTION_GUIDE
static final String	FIX_DELAYED_SHARDS_GUIDE
static final String	INCREASE_CLUSTER_SHARD_LIMIT_ACTION_GUIDE
static final String	INCREASE_SHARD_LIMIT_ACTION_GUIDE
static final String	NAME
static final String	PRIMARY_UNASSIGNED_IMPACT_ID
protected final ProjectResolver	projectResolver
static final String	READ_ONLY_PRIMARY_UNASSIGNED_IMPACT_ID
static final Setting<TimeValue>	REPLICA_UNASSIGNED_BUFFER_TIME
static final String	REPLICA_UNASSIGNED_IMPACT_ID
static final String	RESTORE_FROM_SNAPSHOT_ACTION_GUIDE
static final String	TIER_CAPACITY_ACTION_GUIDE
static final String	WAIT_FOR_INITIALIZATION_GUIDE

Fields inherited from interface org.elasticsearch.health.HealthIndicatorService

MAX_AFFECTED_RESOURCES_COUNT

Constructor Summary

Constructors

Constructor	Description
ShardsAvailabilityHealthIndicatorService(ClusterService clusterService, AllocationService allocationService, SystemIndices systemIndices, ProjectResolver projectResolver)

Method Summary

Modifier and Type	Method	Description
HealthIndicatorResult	calculate(boolean verbose, int maxAffectedResourcesCount, HealthInfo healthInfo)
protected abstract List<Diagnosis.Definition>	checkNodeRoleRelatedIssues(IndexMetadata indexMetadata, List<NodeAllocationResult> nodeAllocationResults, ClusterState clusterState, ShardRouting shardRouting)	Generates a list of diagnoses for common problems that keep a shard from allocating to nodes depending on their role; a very common example of such a case are data tiers.
protected List<Diagnosis.Definition>	checkNodesWithRoleAtShardLimit(IndexMetadata indexMetadata, ClusterState clusterState, List<NodeAllocationResult> nodeRoleAllocationResults, Set<DiscoveryNode> nodesWithRoles, String role)
protected Optional<Diagnosis.Definition>	checkNotEnoughNodesWithRole(List<NodeAllocationResult> nodeAllocationResults, String role)
abstract ShardsAvailabilityHealthIndicatorService.ShardAllocationStatus	createNewStatus(Metadata metadata, int maxAffectedResourcesCount)	Creates a new ShardsAvailabilityHealthIndicatorService.ShardAllocationStatus that will be used to track primary and replica availability, providing the color, diagnosis, and messages about the available or unavailable shards in the cluster.
abstract Diagnosis.Definition	getAddNodesWithRoleAction(String role)
abstract Diagnosis.Definition	getIncreaseNodeWithRoleCapacityAction(String role)
abstract Diagnosis.Definition	getIncreaseShardLimitClusterSettingAction(String role)
abstract Diagnosis.Definition	getIncreaseShardLimitIndexSettingAction(String role)
protected static Predicate<NodeAllocationResult>	hasDeciderResult(String deciderName, Decision.Type outcome)	Convenience method for filtering node allocation results by decider outcomes.
String	name()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.health.HealthIndicatorService

calculate, createIndicator, isPreflight

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

REPLICA_UNASSIGNED_BUFFER_TIME

public static final Setting<TimeValue> REPLICA_UNASSIGNED_BUFFER_TIME

clusterService

protected final ClusterService clusterService

projectResolver

protected final ProjectResolver projectResolver

PRIMARY_UNASSIGNED_IMPACT_ID

public static final String PRIMARY_UNASSIGNED_IMPACT_ID

See Also:

• Constant Field Values

READ_ONLY_PRIMARY_UNASSIGNED_IMPACT_ID

public static final String READ_ONLY_PRIMARY_UNASSIGNED_IMPACT_ID

See Also:

• Constant Field Values

REPLICA_UNASSIGNED_IMPACT_ID

public static final String REPLICA_UNASSIGNED_IMPACT_ID

See Also:

• Constant Field Values

RESTORE_FROM_SNAPSHOT_ACTION_GUIDE

public static final String RESTORE_FROM_SNAPSHOT_ACTION_GUIDE

See Also:

• Constant Field Values

ACTION_RESTORE_FROM_SNAPSHOT

public static final Diagnosis.Definition ACTION_RESTORE_FROM_SNAPSHOT

DIAGNOSE_SHARDS_ACTION_GUIDE

public static final String DIAGNOSE_SHARDS_ACTION_GUIDE

See Also:

• Constant Field Values

ACTION_CHECK_ALLOCATION_EXPLAIN_API

public static final Diagnosis.Definition ACTION_CHECK_ALLOCATION_EXPLAIN_API

FIX_DELAYED_SHARDS_GUIDE

public static final String FIX_DELAYED_SHARDS_GUIDE

See Also:

• Constant Field Values

DIAGNOSIS_WAIT_FOR_OR_FIX_DELAYED_SHARDS

public static final Diagnosis.Definition DIAGNOSIS_WAIT_FOR_OR_FIX_DELAYED_SHARDS

WAIT_FOR_INITIALIZATION_GUIDE

public static final String WAIT_FOR_INITIALIZATION_GUIDE

See Also:

• Constant Field Values

DIAGNOSIS_WAIT_FOR_INITIALIZATION

public static final Diagnosis.Definition DIAGNOSIS_WAIT_FOR_INITIALIZATION

ENABLE_INDEX_ALLOCATION_GUIDE

public static final String ENABLE_INDEX_ALLOCATION_GUIDE

See Also:

• Constant Field Values

ACTION_ENABLE_INDEX_ROUTING_ALLOCATION

public static final Diagnosis.Definition ACTION_ENABLE_INDEX_ROUTING_ALLOCATION

ENABLE_CLUSTER_ALLOCATION_ACTION_GUIDE

public static final String ENABLE_CLUSTER_ALLOCATION_ACTION_GUIDE

See Also:

• Constant Field Values

ACTION_ENABLE_CLUSTER_ROUTING_ALLOCATION

public static final Diagnosis.Definition ACTION_ENABLE_CLUSTER_ROUTING_ALLOCATION

ENABLE_TIER_ACTION_GUIDE

public static final String ENABLE_TIER_ACTION_GUIDE

See Also:

• Constant Field Values

INCREASE_SHARD_LIMIT_ACTION_GUIDE

public static final String INCREASE_SHARD_LIMIT_ACTION_GUIDE

See Also:

• Constant Field Values

ACTION_INCREASE_SHARD_LIMIT_INDEX_SETTING

public static final Diagnosis.Definition ACTION_INCREASE_SHARD_LIMIT_INDEX_SETTING

INCREASE_CLUSTER_SHARD_LIMIT_ACTION_GUIDE

public static final String INCREASE_CLUSTER_SHARD_LIMIT_ACTION_GUIDE

See Also:

• Constant Field Values

ACTION_INCREASE_SHARD_LIMIT_CLUSTER_SETTING

public static final Diagnosis.Definition ACTION_INCREASE_SHARD_LIMIT_CLUSTER_SETTING

TIER_CAPACITY_ACTION_GUIDE

public static final String TIER_CAPACITY_ACTION_GUIDE

See Also:

• Constant Field Values

ACTION_INCREASE_NODE_CAPACITY

public static final Diagnosis.Definition ACTION_INCREASE_NODE_CAPACITY

Constructor Details

ShardsAvailabilityHealthIndicatorService

public ShardsAvailabilityHealthIndicatorService(ClusterService clusterService,
 AllocationService allocationService,
 SystemIndices systemIndices,
 ProjectResolver projectResolver)

Method Details

name

public String name()

Specified by:

name in interface HealthIndicatorService

createNewStatus

public abstract ShardsAvailabilityHealthIndicatorService.ShardAllocationStatus createNewStatus(Metadata metadata,
 int maxAffectedResourcesCount)

Creates a new ShardsAvailabilityHealthIndicatorService.ShardAllocationStatus that will be used to track primary and replica availability, providing the color, diagnosis, and messages about the available or unavailable shards in the cluster.

Parameters:

metadata - Metadata for the cluster

maxAffectedResourcesCount - Max number of affect resources to return

Returns:

A new ShardAllocationStatus that has not yet been filled.

calculate

public HealthIndicatorResult calculate(boolean verbose,
 int maxAffectedResourcesCount,
 HealthInfo healthInfo)

Specified by:

calculate in interface HealthIndicatorService

hasDeciderResult

protected static Predicate<NodeAllocationResult> hasDeciderResult(String deciderName,
 Decision.Type outcome)

Convenience method for filtering node allocation results by decider outcomes.

Parameters:

deciderName - The decider that is being checked

outcome - The outcome expected

Returns:

A predicate that returns true if the decision exists and matches the expected outcome, false otherwise.

checkNodeRoleRelatedIssues

protected abstract List<Diagnosis.Definition> checkNodeRoleRelatedIssues(IndexMetadata indexMetadata,
 List<NodeAllocationResult> nodeAllocationResults,
 ClusterState clusterState,
 ShardRouting shardRouting)

Generates a list of diagnoses for common problems that keep a shard from allocating to nodes depending on their role; a very common example of such a case are data tiers.

Parameters:

indexMetadata - Index metadata for the shard being diagnosed.

nodeAllocationResults - allocation decision results for all nodes in the cluster.

clusterState - the current cluster state.

shardRouting - the shard the nodeAllocationResults refer to

Returns:

A list of diagnoses for the provided unassigned shard

checkNodesWithRoleAtShardLimit

protected List<Diagnosis.Definition> checkNodesWithRoleAtShardLimit(IndexMetadata indexMetadata,
 ClusterState clusterState,
 List<NodeAllocationResult> nodeRoleAllocationResults,
 Set<DiscoveryNode> nodesWithRoles,
 @Nullable
 String role)

checkNotEnoughNodesWithRole

protected Optional<Diagnosis.Definition> checkNotEnoughNodesWithRole(List<NodeAllocationResult> nodeAllocationResults,
 @Nullable
 String role)

getAddNodesWithRoleAction

@Nullable
public abstract Diagnosis.Definition getAddNodesWithRoleAction(String role)

getIncreaseShardLimitIndexSettingAction

@Nullable
public abstract Diagnosis.Definition getIncreaseShardLimitIndexSettingAction(String role)

getIncreaseShardLimitClusterSettingAction

@Nullable
public abstract Diagnosis.Definition getIncreaseShardLimitClusterSettingAction(String role)

getIncreaseNodeWithRoleCapacityAction

@Nullable
public abstract Diagnosis.Definition getIncreaseNodeWithRoleCapacityAction(String role)