org.elasticsearch.action.admin.cluster.allocation

Class TransportClusterAllocationExplainAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.action.support.TransportAction<Request,Response>

org.elasticsearch.action.support.HandledTransportAction<Request,Response>

org.elasticsearch.action.support.master.TransportMasterNodeAction<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse>

org.elasticsearch.action.admin.cluster.allocation.TransportClusterAllocationExplainAction

public class TransportClusterAllocationExplainAction
extends TransportMasterNodeAction<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse>

The TransportClusterAllocationExplainAction is responsible for actually executing the explanation of a shard's allocation on the master node in the cluster.

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.TransportMasterNodeAction

clusterService, transportService

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description

TransportClusterAllocationExplainAction(Settings settings, TransportService transportService, ClusterService clusterService, ThreadPool threadPool, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, ClusterInfoService clusterInfoService, AllocationDeciders allocationDeciders, ShardsAllocator shardAllocator, TransportIndicesShardStoresAction shardStoresAction, GatewayAllocator gatewayAllocator)

Method Summary

Modifier and Type	Method and Description
static NodeExplanation	calculateNodeExplanation(ShardRouting shard, IndexMetaData indexMetaData, DiscoveryNode node, Decision nodeDecision, java.lang.Float nodeWeight, IndicesShardStoresResponse.StoreStatus storeStatus, java.lang.String assignedNodeId, java.util.Set<java.lang.String> activeAllocationIds, boolean hasPendingAsyncFetch) Construct a NodeExplanation object for the given shard given all the metadata.
protected ClusterBlockException	checkBlock(ClusterAllocationExplainRequest request, ClusterState state)
protected java.lang.String	executor()
static ClusterAllocationExplanation	explainShard(ShardRouting shard, RoutingAllocation allocation, RoutingNodes routingNodes, boolean includeYesDecisions, ShardsAllocator shardAllocator, java.util.List<IndicesShardStoresResponse.StoreStatus> shardStores, GatewayAllocator gatewayAllocator, ClusterInfo clusterInfo) For the given ShardRouting, return the explanation of the allocation for that shard on all nodes.
protected void	masterOperation(ClusterAllocationExplainRequest request, ClusterState state, ActionListener<ClusterAllocationExplainResponse> listener)
protected ClusterAllocationExplainResponse	newResponse()
static Decision	tryShardOnNode(ShardRouting shard, RoutingNode node, RoutingAllocation allocation, boolean includeYesDecisions) Return the decisions for the given ShardRouting on the given RoutingNode.

Methods inherited from class org.elasticsearch.action.support.master.TransportMasterNodeAction

doExecute, doExecute, localExecute, masterOperation

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, execute, execute, execute

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportClusterAllocationExplainAction

@Inject
public TransportClusterAllocationExplainAction(Settings settings,
                                                       TransportService transportService,
                                                       ClusterService clusterService,
                                                       ThreadPool threadPool,
                                                       ActionFilters actionFilters,
                                                       IndexNameExpressionResolver indexNameExpressionResolver,
                                                       ClusterInfoService clusterInfoService,
                                                       AllocationDeciders allocationDeciders,
                                                       ShardsAllocator shardAllocator,
                                                       TransportIndicesShardStoresAction shardStoresAction,
                                                       GatewayAllocator gatewayAllocator)

Method Detail

executor

protected java.lang.String executor()

Specified by:

executor in class TransportMasterNodeAction<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse>

checkBlock

protected ClusterBlockException checkBlock(ClusterAllocationExplainRequest request,
                                           ClusterState state)

Specified by:

checkBlock in class TransportMasterNodeAction<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse>

newResponse

protected ClusterAllocationExplainResponse newResponse()

Specified by:

newResponse in class TransportMasterNodeAction<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse>

tryShardOnNode

public static Decision tryShardOnNode(ShardRouting shard,
                                      RoutingNode node,
                                      RoutingAllocation allocation,
                                      boolean includeYesDecisions)

Return the decisions for the given ShardRouting on the given RoutingNode. If includeYesDecisions is not true, only non-YES (NO and THROTTLE) decisions are returned.

calculateNodeExplanation

public static NodeExplanation calculateNodeExplanation(ShardRouting shard,
                                                       IndexMetaData indexMetaData,
                                                       DiscoveryNode node,
                                                       Decision nodeDecision,
                                                       java.lang.Float nodeWeight,
                                                       IndicesShardStoresResponse.StoreStatus storeStatus,
                                                       java.lang.String assignedNodeId,
                                                       java.util.Set<java.lang.String> activeAllocationIds,
                                                       boolean hasPendingAsyncFetch)

Construct a NodeExplanation object for the given shard given all the metadata. This also attempts to construct the human readable FinalDecision and final explanation as part of the explanation.

explainShard

public static ClusterAllocationExplanation explainShard(ShardRouting shard,
                                                        RoutingAllocation allocation,
                                                        RoutingNodes routingNodes,
                                                        boolean includeYesDecisions,
                                                        ShardsAllocator shardAllocator,
                                                        java.util.List<IndicesShardStoresResponse.StoreStatus> shardStores,
                                                        GatewayAllocator gatewayAllocator,
                                                        ClusterInfo clusterInfo)

For the given ShardRouting, return the explanation of the allocation for that shard on all nodes. If includeYesDecisions is true, returns all decisions, otherwise returns only 'NO' and 'THROTTLE' decisions.

masterOperation

protected void masterOperation(ClusterAllocationExplainRequest request,
                               ClusterState state,
                               ActionListener<ClusterAllocationExplainResponse> listener)

Specified by:

masterOperation in class TransportMasterNodeAction<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse>