org.elasticsearch.index.seqno

Class GlobalCheckpointSyncAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

org.elasticsearch.action.support.replication.TransportReplicationAction<GlobalCheckpointSyncAction.Request,GlobalCheckpointSyncAction.Request,ReplicationResponse>

org.elasticsearch.index.seqno.GlobalCheckpointSyncAction

All Implemented Interfaces:

IndexEventListener

public class GlobalCheckpointSyncAction
extends TransportReplicationAction<GlobalCheckpointSyncAction.Request,GlobalCheckpointSyncAction.Request,ReplicationResponse>
implements IndexEventListener

Background global checkpoint sync action initiated when a shard goes inactive. This is needed because while we send the global checkpoint on every replication operation, after the last operation completes the global checkpoint could advance but without a follow-up operation the global checkpoint will never be synced to the replicas.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalCheckpointSyncAction.Request

Nested classes/interfaces inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

TransportReplicationAction.ConcreteReplicaRequest<R extends TransportRequest>, TransportReplicationAction.ConcreteShardRequest<R extends TransportRequest>, TransportReplicationAction.OperationTransportHandler, TransportReplicationAction.PrimaryOperationTransportHandler, TransportReplicationAction.PrimaryResult<ReplicaRequest extends ReplicationRequest<ReplicaRequest>,Response extends ReplicationResponse>, TransportReplicationAction.ReplicaOperationTransportHandler, TransportReplicationAction.ReplicaResponse, TransportReplicationAction.ReplicaResult, TransportReplicationAction.ReplicasProxy, TransportReplicationAction.RetryOnReplicaException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME

Fields inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

clusterService, executor, indicesService, shardStateAction, transportOptions, transportPrimaryAction, transportReplicaAction, transportService

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

actionName, indexNameExpressionResolver, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
GlobalCheckpointSyncAction(Settings settings, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method and Description
protected ReplicationResponse	newResponseInstance()
void	onShardInactive(IndexShard indexShard) Called when a shard is marked as inactive
protected void	sendReplicaRequest(TransportReplicationAction.ConcreteReplicaRequest<GlobalCheckpointSyncAction.Request> replicaRequest, DiscoveryNode node, ActionListener<ReplicationOperation.ReplicaResponse> listener) Sends the specified replica request to the specified node.
protected TransportReplicationAction.PrimaryResult<GlobalCheckpointSyncAction.Request,ReplicationResponse>	shardOperationOnPrimary(GlobalCheckpointSyncAction.Request request, IndexShard indexShard) Primary operation on node with primary copy.
protected TransportReplicationAction.ReplicaResult	shardOperationOnReplica(GlobalCheckpointSyncAction.Request request, IndexShard indexShard) Synchronously execute the specified replica operation.

Methods inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

doExecute, doExecute, getIndexShard, globalBlockLevel, indexBlockLevel, newReplicasProxy, registerRequestHandlers, resolveIndex, resolveRequest, retryPrimaryException, transportOptions

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

Methods inherited from interface org.elasticsearch.index.shard.IndexEventListener

afterIndexCreated, afterIndexRemoved, afterIndexShardClosed, afterIndexShardCreated, afterIndexShardDeleted, afterIndexShardStarted, beforeIndexAddedToCluster, beforeIndexCreated, beforeIndexRemoved, beforeIndexShardClosed, beforeIndexShardCreated, beforeIndexShardDeleted, indexShardStateChanged, onStoreClosed, shardRoutingChanged

Field Detail

ACTION_NAME

public static java.lang.String ACTION_NAME

Constructor Detail

GlobalCheckpointSyncAction

@Inject
public GlobalCheckpointSyncAction(Settings settings,
                                          TransportService transportService,
                                          ClusterService clusterService,
                                          IndicesService indicesService,
                                          ThreadPool threadPool,
                                          ShardStateAction shardStateAction,
                                          ActionFilters actionFilters,
                                          IndexNameExpressionResolver indexNameExpressionResolver)

Method Detail

newResponseInstance

protected ReplicationResponse newResponseInstance()

Specified by:

newResponseInstance in class TransportReplicationAction<GlobalCheckpointSyncAction.Request,GlobalCheckpointSyncAction.Request,ReplicationResponse>

sendReplicaRequest

protected void sendReplicaRequest(TransportReplicationAction.ConcreteReplicaRequest<GlobalCheckpointSyncAction.Request> replicaRequest,
                                  DiscoveryNode node,
                                  ActionListener<ReplicationOperation.ReplicaResponse> listener)

Description copied from class: TransportReplicationAction

Sends the specified replica request to the specified node.

Overrides:

sendReplicaRequest in class TransportReplicationAction<GlobalCheckpointSyncAction.Request,GlobalCheckpointSyncAction.Request,ReplicationResponse>

Parameters:

replicaRequest - the replica request

node - the node to send the request to

listener - callback for handling the response or failure

onShardInactive

public void onShardInactive(IndexShard indexShard)

Description copied from interface: IndexEventListener

Called when a shard is marked as inactive

Specified by:

onShardInactive in interface IndexEventListener

Parameters:

indexShard - The shard that was marked inactive

shardOperationOnPrimary

protected TransportReplicationAction.PrimaryResult<GlobalCheckpointSyncAction.Request,ReplicationResponse> shardOperationOnPrimary(GlobalCheckpointSyncAction.Request request,
                                                                                                                                   IndexShard indexShard)
                                                                                                                            throws java.lang.Exception

Description copied from class: TransportReplicationAction

Primary operation on node with primary copy.

Specified by:

shardOperationOnPrimary in class TransportReplicationAction<GlobalCheckpointSyncAction.Request,GlobalCheckpointSyncAction.Request,ReplicationResponse>

Parameters:

request - the request to the primary shard

indexShard - the primary shard to perform the operation on

Throws:

java.lang.Exception

shardOperationOnReplica

protected TransportReplicationAction.ReplicaResult shardOperationOnReplica(GlobalCheckpointSyncAction.Request request,
                                                                           IndexShard indexShard)
                                                                    throws java.lang.Exception

Description copied from class: TransportReplicationAction

Synchronously execute the specified replica operation. This is done under a permit from IndexShard.acquireReplicaOperationPermit(long, long, ActionListener, String).

Specified by:

shardOperationOnReplica in class TransportReplicationAction<GlobalCheckpointSyncAction.Request,GlobalCheckpointSyncAction.Request,ReplicationResponse>

Parameters:

request - the request to the replica shard

indexShard - the replica shard to perform the operation on

Throws:

java.lang.Exception