Class RecoveryTarget
- java.lang.Object
-
- org.elasticsearch.common.util.concurrent.AbstractRefCounted
-
- org.elasticsearch.indices.recovery.RecoveryTarget
-
- All Implemented Interfaces:
RefCounted
,RecoveryTargetHandler
public class RecoveryTarget extends AbstractRefCounted implements RecoveryTargetHandler
Represents a recovery where the current node is the target node of the recovery. To track recoveries in a central place, instances of this class are created throughRecoveriesCollection
.
-
-
Constructor Summary
Constructors Constructor Description RecoveryTarget(IndexShard indexShard, DiscoveryNode sourceNode, PeerRecoveryTargetService.RecoveryListener listener, java.util.function.LongConsumer ensureClusterStateVersionCallback)
Creates a new recovery target object that represents a recovery to the provided shard.
-
Method Summary
Modifier and Type Method Description void
cancel(java.lang.String reason)
cancel the recovery.CancellableThreads
cancellableThreads()
void
cleanFiles(int totalTranslogOps, Store.MetadataSnapshot sourceMetaData)
After all source files has been sent over, this command is sent to the target so it can clean any local files that are not part of the source storeprotected void
closeInternal()
void
ensureClusterStateVersion(long clusterStateVersion)
Blockingly waits for cluster state with at least clusterStateVersion to be availablevoid
fail(RecoveryFailedException e, boolean sendShardFailure)
fail the recovery and call listenervoid
finalizeRecovery(long globalCheckpoint, ActionListener<java.lang.Void> listener)
The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, updates the global checkpoint.java.lang.String
getTempNameForFile(java.lang.String origFile)
Get a temporary name for the provided file name.void
handoffPrimaryContext(ReplicationTracker.PrimaryContext primaryContext)
Handoff the primary context between the relocation source and the relocation target.IndexShard
indexShard()
void
indexTranslogOperations(java.util.List<Translog.Operation> operations, int totalTranslogOps, long maxSeenAutoIdTimestampOnPrimary, long maxSeqNoOfDeletesOrUpdatesOnPrimary, RetentionLeases retentionLeases, ActionListener<java.lang.Long> listener)
Index a set of translog operations on the targetlong
lastAccessTime()
return the last time this RecoveryStatus was used (based on System.nanoTime()void
markAsDone()
mark the current recovery as donevoid
notifyListener(RecoveryFailedException e, boolean sendShardFailure)
void
prepareForTranslogOperations(boolean fileBasedRecovery, int totalTranslogOps, ActionListener<java.lang.Void> listener)
Implementation ofRecoveryTargetHandler
void
receiveFileInfo(java.util.List<java.lang.String> phase1FileNames, java.util.List<java.lang.Long> phase1FileSizes, java.util.List<java.lang.String> phase1ExistingFileNames, java.util.List<java.lang.Long> phase1ExistingFileSizes, int totalTranslogOps)
Notifies the target of the files it is going to receivelong
recoveryId()
RecoveryTarget
retryCopy()
Returns a fresh recovery target to retry recovery from the same source node onto the same shard and using the same listener.void
setLastAccessTime()
sets the lasAccessTime flag to nowShardId
shardId()
DiscoveryNode
sourceNode()
RecoveryState.Stage
stage()
RecoveryState
state()
Store
store()
java.lang.String
toString()
void
writeFileChunk(StoreFileMetaData fileMetaData, long position, BytesReference content, boolean lastChunk, int totalTranslogOps, ActionListener<java.lang.Void> listener)
writes a partial file chunk to the target store-
Methods inherited from class org.elasticsearch.common.util.concurrent.AbstractRefCounted
alreadyClosed, decRef, getName, incRef, refCount, tryIncRef
-
-
-
-
Constructor Detail
-
RecoveryTarget
public RecoveryTarget(IndexShard indexShard, DiscoveryNode sourceNode, PeerRecoveryTargetService.RecoveryListener listener, java.util.function.LongConsumer ensureClusterStateVersionCallback)
Creates a new recovery target object that represents a recovery to the provided shard.- Parameters:
indexShard
- local shard where we want to recover tosourceNode
- source node of the recovery where we recover fromlistener
- called when recovery is completed/failedensureClusterStateVersionCallback
- callback to ensure that the current node is at least on a cluster state with the provided version; necessary for primary relocation so that new primary knows about all other ongoing replica recoveries when replicating documents (seeRecoverySourceHandler
)
-
-
Method Detail
-
retryCopy
public RecoveryTarget retryCopy()
Returns a fresh recovery target to retry recovery from the same source node onto the same shard and using the same listener.- Returns:
- a copy of this recovery target
-
recoveryId
public long recoveryId()
-
shardId
public ShardId shardId()
-
indexShard
public IndexShard indexShard()
-
sourceNode
public DiscoveryNode sourceNode()
-
state
public RecoveryState state()
-
cancellableThreads
public CancellableThreads cancellableThreads()
-
lastAccessTime
public long lastAccessTime()
return the last time this RecoveryStatus was used (based on System.nanoTime()
-
setLastAccessTime
public void setLastAccessTime()
sets the lasAccessTime flag to now
-
store
public Store store()
-
stage
public RecoveryState.Stage stage()
-
cancel
public void cancel(java.lang.String reason)
cancel the recovery. calling this method will clean temporary files and release the store unless this object is in use (in which case it will be cleaned once all ongoing users callAbstractRefCounted.decRef()
if
cancellableThreads()
was used, the threads will be interrupted.
-
fail
public void fail(RecoveryFailedException e, boolean sendShardFailure)
fail the recovery and call listener- Parameters:
e
- exception that encapsulating the failuresendShardFailure
- indicates whether to notify the master of the shard failure
-
notifyListener
public void notifyListener(RecoveryFailedException e, boolean sendShardFailure)
-
markAsDone
public void markAsDone()
mark the current recovery as done
-
closeInternal
protected void closeInternal()
- Specified by:
closeInternal
in classAbstractRefCounted
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
prepareForTranslogOperations
public void prepareForTranslogOperations(boolean fileBasedRecovery, int totalTranslogOps, ActionListener<java.lang.Void> listener)
Implementation ofRecoveryTargetHandler
- Specified by:
prepareForTranslogOperations
in interfaceRecoveryTargetHandler
- Parameters:
fileBasedRecovery
- whether or not this call is part of an file based recoverytotalTranslogOps
- total translog operations expected to be sent
-
finalizeRecovery
public void finalizeRecovery(long globalCheckpoint, ActionListener<java.lang.Void> listener)
Description copied from interface:RecoveryTargetHandler
The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, updates the global checkpoint.- Specified by:
finalizeRecovery
in interfaceRecoveryTargetHandler
- Parameters:
globalCheckpoint
- the global checkpoint on the recovery sourcelistener
- the listener which will be notified when this method is completed
-
ensureClusterStateVersion
public void ensureClusterStateVersion(long clusterStateVersion)
Description copied from interface:RecoveryTargetHandler
Blockingly waits for cluster state with at least clusterStateVersion to be available- Specified by:
ensureClusterStateVersion
in interfaceRecoveryTargetHandler
-
handoffPrimaryContext
public void handoffPrimaryContext(ReplicationTracker.PrimaryContext primaryContext)
Description copied from interface:RecoveryTargetHandler
Handoff the primary context between the relocation source and the relocation target.- Specified by:
handoffPrimaryContext
in interfaceRecoveryTargetHandler
- Parameters:
primaryContext
- the primary context from the relocation source
-
indexTranslogOperations
public void indexTranslogOperations(java.util.List<Translog.Operation> operations, int totalTranslogOps, long maxSeenAutoIdTimestampOnPrimary, long maxSeqNoOfDeletesOrUpdatesOnPrimary, RetentionLeases retentionLeases, ActionListener<java.lang.Long> listener)
Description copied from interface:RecoveryTargetHandler
Index a set of translog operations on the target- Specified by:
indexTranslogOperations
in interfaceRecoveryTargetHandler
- Parameters:
operations
- operations to indextotalTranslogOps
- current number of total operations expected to be indexedmaxSeenAutoIdTimestampOnPrimary
- the maximum auto_id_timestamp of all append-only requests processed by the primary shardmaxSeqNoOfDeletesOrUpdatesOnPrimary
- the max seq_no of update operations (index operations overwrite Lucene) or delete ops on the primary shard when capturing these operations. This value is at least as high as the max_seq_no_of_updates on the primary was when any of these ops were processed on it.retentionLeases
- the retention leases on the primarylistener
- a listener which will be notified with the local checkpoint on the target after these operations are successfully indexed on the target.
-
receiveFileInfo
public void receiveFileInfo(java.util.List<java.lang.String> phase1FileNames, java.util.List<java.lang.Long> phase1FileSizes, java.util.List<java.lang.String> phase1ExistingFileNames, java.util.List<java.lang.Long> phase1ExistingFileSizes, int totalTranslogOps)
Description copied from interface:RecoveryTargetHandler
Notifies the target of the files it is going to receive- Specified by:
receiveFileInfo
in interfaceRecoveryTargetHandler
-
cleanFiles
public void cleanFiles(int totalTranslogOps, Store.MetadataSnapshot sourceMetaData) throws java.io.IOException
Description copied from interface:RecoveryTargetHandler
After all source files has been sent over, this command is sent to the target so it can clean any local files that are not part of the source store- Specified by:
cleanFiles
in interfaceRecoveryTargetHandler
- Parameters:
totalTranslogOps
- an update number of translog operations that will be replayed later onsourceMetaData
- meta data of the source store- Throws:
java.io.IOException
-
writeFileChunk
public void writeFileChunk(StoreFileMetaData fileMetaData, long position, BytesReference content, boolean lastChunk, int totalTranslogOps, ActionListener<java.lang.Void> listener)
Description copied from interface:RecoveryTargetHandler
writes a partial file chunk to the target store- Specified by:
writeFileChunk
in interfaceRecoveryTargetHandler
-
getTempNameForFile
public java.lang.String getTempNameForFile(java.lang.String origFile)
Get a temporary name for the provided file name.
-
-