org.elasticsearch.index.seqno

Class SequenceNumbersService

java.lang.Object

org.elasticsearch.index.shard.AbstractIndexShardComponent

org.elasticsearch.index.seqno.SequenceNumbersService

All Implemented Interfaces:

IndexShardComponent

public class SequenceNumbersService
extends AbstractIndexShardComponent

Encapsulates the local and global checkpoints into a single service for use as a shard component.

Field Summary

Fields inherited from class org.elasticsearch.index.shard.AbstractIndexShardComponent

deprecationLogger, indexSettings, logger, shardId

Constructor Summary

Constructors

Constructor and Description
SequenceNumbersService(ShardId shardId, java.lang.String allocationId, IndexSettings indexSettings, long maxSeqNo, long localCheckpoint, long globalCheckpoint) Initialize the sequence number service.

Method Summary

Modifier and Type	Method and Description
void	abortRelocationHandoff() Fails a relocation handoff attempt.
void	activatePrimaryMode(long localCheckpoint) Activates the global checkpoint tracker in primary mode (see GlobalCheckpointTracker.primaryMode.
void	activateWithPrimaryContext(GlobalCheckpointTracker.PrimaryContext primaryContext) Activates the global checkpoint tracker in primary mode (see GlobalCheckpointTracker.primaryMode.
void	completeRelocationHandoff() Marks a relocation handoff attempt as successful.
long	generateSeqNo() Issue the next sequence number.
long	getGlobalCheckpoint() Returns the global checkpoint for the shard.
com.carrotsearch.hppc.ObjectLongMap<java.lang.String>	getInSyncGlobalCheckpoints() Get the local knowledge of the global checkpoints for all in-sync allocation IDs.
long	getLocalCheckpoint() Returns the local checkpoint for the shard.
long	getMaxSeqNo() The maximum sequence number issued so far.
ReplicationGroup	getReplicationGroup() Returns the current replication group for the shard.
long	getTrackedLocalCheckpointForShard(java.lang.String allocationId) Returns the local checkpoint information tracked for a specific shard.
void	initiateTracking(java.lang.String allocationId) Called when the recovery process for a shard is ready to open the engine on the target shard.
void	markAllocationIdAsInSync(java.lang.String allocationId, long localCheckpoint) Marks the shard with the provided allocation ID as in-sync with the primary shard.
void	markSeqNoAsCompleted(long seqNo) Marks the processing of the provided sequence number as completed as updates the checkpoint if possible.
boolean	pendingInSync() Check if there are any recoveries pending in-sync.
void	resetLocalCheckpoint(long localCheckpoint) Resets the local checkpoint to the specified value.
GlobalCheckpointTracker.PrimaryContext	startRelocationHandoff() Get the primary context for the shard.
SeqNoStats	stats() The current sequence number stats.
void	updateAllocationIdsFromMaster(long applyingClusterStateVersion, java.util.Set<java.lang.String> inSyncAllocationIds, IndexShardRoutingTable routingTable, java.util.Set<java.lang.String> pre60AllocationIds) Notifies the service of the current allocation IDs in the cluster state.
void	updateGlobalCheckpointForShard(java.lang.String allocationId, long globalCheckpoint) Update the local knowledge of the global checkpoint for the specified allocation ID.
void	updateGlobalCheckpointOnReplica(long globalCheckpoint, java.lang.String reason) Updates the global checkpoint on a replica shard after it has been updated by the primary.
void	updateLocalCheckpointForShard(java.lang.String allocationId, long checkpoint) Notifies the service to update the local checkpoint for the shard with the provided allocation ID.
void	waitForOpsToComplete(long seqNo) Waits for all operations up to the provided sequence number to complete.

Methods inherited from class org.elasticsearch.index.shard.AbstractIndexShardComponent

indexSettings, nodeName, shardId

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceNumbersService

public SequenceNumbersService(ShardId shardId,
                              java.lang.String allocationId,
                              IndexSettings indexSettings,
                              long maxSeqNo,
                              long localCheckpoint,
                              long globalCheckpoint)

Initialize the sequence number service. The maxSeqNo should be set to the last sequence number assigned by this shard, or SequenceNumbers.NO_OPS_PERFORMED, localCheckpoint should be set to the last known local checkpoint for this shard, or SequenceNumbers.NO_OPS_PERFORMED, and globalCheckpoint should be set to the last known global checkpoint for this shard, or SequenceNumbers.UNASSIGNED_SEQ_NO.

Parameters:

shardId - the shard this service is providing tracking local checkpoints for

indexSettings - the index settings

maxSeqNo - the last sequence number assigned by this shard, or SequenceNumbers.NO_OPS_PERFORMED

localCheckpoint - the last known local checkpoint for this shard, or SequenceNumbers.NO_OPS_PERFORMED

globalCheckpoint - the last known global checkpoint for this shard, or SequenceNumbers.UNASSIGNED_SEQ_NO

Method Detail

generateSeqNo

public final long generateSeqNo()

Issue the next sequence number. Note that you must call markSeqNoAsCompleted(long) after the operation for which the issued sequence number completes (whether or not the operation completes successfully).

Returns:

the next assigned sequence number

getMaxSeqNo

public long getMaxSeqNo()

The maximum sequence number issued so far. See LocalCheckpointTracker.getMaxSeqNo() for additional details.

Returns:

the maximum sequence number

waitForOpsToComplete

public void waitForOpsToComplete(long seqNo)
                          throws java.lang.InterruptedException

Waits for all operations up to the provided sequence number to complete.

Parameters:

seqNo - the sequence number that the checkpoint must advance to before this method returns

Throws:

java.lang.InterruptedException - if the thread was interrupted while blocking on the condition

markSeqNoAsCompleted

public void markSeqNoAsCompleted(long seqNo)

Marks the processing of the provided sequence number as completed as updates the checkpoint if possible. See LocalCheckpointTracker.markSeqNoAsCompleted(long) for additional details.

Parameters:

seqNo - the sequence number to mark as completed

resetLocalCheckpoint

public void resetLocalCheckpoint(long localCheckpoint)

Resets the local checkpoint to the specified value.

Parameters:

localCheckpoint - the local checkpoint to reset to

stats

public SeqNoStats stats()

The current sequence number stats.

Returns:

stats encapsulating the maximum sequence number, the local checkpoint and the global checkpoint

updateLocalCheckpointForShard

public void updateLocalCheckpointForShard(java.lang.String allocationId,
                                          long checkpoint)

Notifies the service to update the local checkpoint for the shard with the provided allocation ID. See GlobalCheckpointTracker.updateLocalCheckpoint(String, long) for details.

Parameters:

allocationId - the allocation ID of the shard to update the local checkpoint for

checkpoint - the local checkpoint for the shard

updateGlobalCheckpointForShard

public void updateGlobalCheckpointForShard(java.lang.String allocationId,
                                           long globalCheckpoint)

Update the local knowledge of the global checkpoint for the specified allocation ID.

Parameters:

allocationId - the allocation ID to update the global checkpoint for

globalCheckpoint - the global checkpoint

getInSyncGlobalCheckpoints

public com.carrotsearch.hppc.ObjectLongMap<java.lang.String> getInSyncGlobalCheckpoints()

Get the local knowledge of the global checkpoints for all in-sync allocation IDs.

Returns:

a map from allocation ID to the local knowledge of the global checkpoint for that allocation ID

initiateTracking

public void initiateTracking(java.lang.String allocationId)

Called when the recovery process for a shard is ready to open the engine on the target shard. See GlobalCheckpointTracker.initiateTracking(String) for details.

Parameters:

allocationId - the allocation ID of the shard for which recovery was initiated

markAllocationIdAsInSync

public void markAllocationIdAsInSync(java.lang.String allocationId,
                                     long localCheckpoint)
                              throws java.lang.InterruptedException

Marks the shard with the provided allocation ID as in-sync with the primary shard. See GlobalCheckpointTracker.markAllocationIdAsInSync(String, long) for additional details.

Parameters:

allocationId - the allocation ID of the shard to mark as in-sync

localCheckpoint - the current local checkpoint on the shard

Throws:

java.lang.InterruptedException

getLocalCheckpoint

public long getLocalCheckpoint()

Returns the local checkpoint for the shard.

Returns:

the local checkpoint

getReplicationGroup

public ReplicationGroup getReplicationGroup()

Returns the current replication group for the shard.

Returns:

the replication group

getGlobalCheckpoint

public long getGlobalCheckpoint()

Returns the global checkpoint for the shard.

Returns:

the global checkpoint

updateGlobalCheckpointOnReplica

public void updateGlobalCheckpointOnReplica(long globalCheckpoint,
                                            java.lang.String reason)

Updates the global checkpoint on a replica shard after it has been updated by the primary.

Parameters:

globalCheckpoint - the global checkpoint

reason - the reason the global checkpoint was updated

getTrackedLocalCheckpointForShard

public long getTrackedLocalCheckpointForShard(java.lang.String allocationId)

Returns the local checkpoint information tracked for a specific shard. Used by tests.

activatePrimaryMode

public void activatePrimaryMode(long localCheckpoint)

Activates the global checkpoint tracker in primary mode (see GlobalCheckpointTracker.primaryMode. Called on primary activation or promotion.

updateAllocationIdsFromMaster

public void updateAllocationIdsFromMaster(long applyingClusterStateVersion,
                                          java.util.Set<java.lang.String> inSyncAllocationIds,
                                          IndexShardRoutingTable routingTable,
                                          java.util.Set<java.lang.String> pre60AllocationIds)

Notifies the service of the current allocation IDs in the cluster state. See GlobalCheckpointTracker.updateFromMaster(long, Set, IndexShardRoutingTable, Set) for details.

Parameters:

applyingClusterStateVersion - the cluster state version being applied when updating the allocation IDs from the master

inSyncAllocationIds - the allocation IDs of the currently in-sync shard copies

routingTable - the shard routing table

pre60AllocationIds - the allocation IDs of shards that are allocated to pre-6.0 nodes

activateWithPrimaryContext

public void activateWithPrimaryContext(GlobalCheckpointTracker.PrimaryContext primaryContext)

Activates the global checkpoint tracker in primary mode (see GlobalCheckpointTracker.primaryMode. Called on primary relocation target during primary relocation handoff.

Parameters:

primaryContext - the primary context used to initialize the state

pendingInSync

public boolean pendingInSync()

Check if there are any recoveries pending in-sync.

Returns:

true if there is at least one shard pending in-sync, otherwise false

startRelocationHandoff

public GlobalCheckpointTracker.PrimaryContext startRelocationHandoff()

Get the primary context for the shard. This includes the state of the global checkpoint tracker.

Returns:

the primary context

completeRelocationHandoff

public void completeRelocationHandoff()

Marks a relocation handoff attempt as successful. Moves the tracker into replica mode.

abortRelocationHandoff

public void abortRelocationHandoff()

Fails a relocation handoff attempt.