Package org.opensearch.index.engine

Class NRTReplicationEngine

java.lang.Object
org.opensearch.index.engine.Engine
org.opensearch.index.engine.NRTReplicationEngine
All Implemented Interfaces:
Closeable, AutoCloseable, LifecycleAware
@PublicApi(since="1.0.0") public class NRTReplicationEngine extends Engine implements LifecycleAware
This is an Engine implementation intended for replica shards when Segment Replication is enabled. This Engine does not create an IndexWriter, rather it refreshes a NRTReplicationReaderManager with new Segments when received from an external source.
Opensearch.api:

  • Field Details

    • replicaFileTracker

      protected final org.opensearch.index.engine.ReplicaFileTracker replicaFileTracker

  • Constructor Details

    • NRTReplicationEngine

      public NRTReplicationEngine(EngineConfig engineConfig)

  • Method Details

    • cleanUnreferencedFiles

      public void cleanUnreferencedFiles() throws IOException
      Throws:
      IOException

    • translogManager

      public TranslogManager translogManager()

    • updateSegments

      public void updateSegments(org.apache.lucene.index.SegmentInfos infos) throws IOException
      Throws:
      IOException

    • getHistoryUUID

      public String getHistoryUUID()
      Description copied from class: Engine
      returns the history uuid for the engine
      Specified by:
      getHistoryUUID in class Engine

    • getWritingBytes

      public long getWritingBytes()
      Description copied from class: Engine
      Returns how many bytes we are currently moving from heap to disk
      Specified by:
      getWritingBytes in class Engine

    • completionStats

      public CompletionStats completionStats(String... fieldNamePatterns)
      Description copied from class: Engine
      Returns the CompletionStats for this engine
      Specified by:
      completionStats in class Engine

    • getIndexThrottleTimeInMillis

      public long getIndexThrottleTimeInMillis()
      Description copied from class: Engine
      Returns the number of milliseconds this engine was under index throttling.
      Specified by:
      getIndexThrottleTimeInMillis in class Engine

    • isThrottled

      public boolean isThrottled()
      Description copied from class: Engine
      Returns the true iff this engine is currently under index throttling.
      Specified by:
      isThrottled in class Engine
      See Also:

    • trimOperationsFromTranslog

      public void trimOperationsFromTranslog(long belowTerm, long aboveSeqNo) throws EngineException
      Description copied from class: Engine
      Trims translog for terms below belowTerm and seq# above aboveSeqNo
      Specified by:
      trimOperationsFromTranslog in class Engine
      Throws:
      EngineException
      See Also:

    • index

      public Engine.IndexResult index(Engine.Index index) throws IOException
      Description copied from class: Engine
      Perform document index operation on the engine
      Specified by:
      index in class Engine
      Parameters:
      index - operation to perform
      Returns:
      Engine.IndexResult containing updated translog location, version and document specific failures Note: engine level failures (i.e. persistent engine failures) are thrown
      Throws:
      IOException

    • delete

      public Engine.DeleteResult delete(Engine.Delete delete) throws IOException
      Description copied from class: Engine
      Perform document delete operation on the engine
      Specified by:
      delete in class Engine
      Parameters:
      delete - operation to perform
      Returns:
      Engine.DeleteResult containing updated translog location, version and document specific failures Note: engine level failures (i.e. persistent engine failures) are thrown
      Throws:
      IOException

    • noOp

      public Engine.NoOpResult noOp(Engine.NoOp noOp) throws IOException
      Specified by:
      noOp in class Engine
      Throws:
      IOException

    • get

      public Engine.GetResult get(Engine.Get get, BiFunction<String,Engine.SearcherScope,Engine.Searcher> searcherFactory) throws EngineException
      Specified by:
      get in class Engine
      Throws:
      EngineException

    • getReferenceManager

      protected org.apache.lucene.search.ReferenceManager<OpenSearchDirectoryReader> getReferenceManager(Engine.SearcherScope scope)
      Specified by:
      getReferenceManager in class Engine

    • refreshNeeded

      public boolean refreshNeeded()
      Refreshing of this engine will only happen internally when a new set of segments is received. The engine will ignore external refresh attempts so we can return false here. Further Engine's existing implementation reads DirectoryReader.isCurrent after acquiring a searcher. With this Engine's NRTReplicationReaderManager, This will use StandardDirectoryReader's implementation which determines if the reader is current by comparing the on-disk SegmentInfos version against the one in the reader, which at refresh points will always return isCurrent false and then refreshNeeded true. Even if this method returns refresh as needed, we ignore it and only ever refresh with incoming SegmentInfos.
      Overrides:
      refreshNeeded in class Engine

    • isTranslogSyncNeeded

      public boolean isTranslogSyncNeeded()
      Description copied from class: Engine
      Checks if the underlying storage sync is required.
      Specified by:
      isTranslogSyncNeeded in class Engine

    • ensureTranslogSynced

      public boolean ensureTranslogSynced(Stream<Translog.Location> locations) throws IOException
      Description copied from class: Engine
      Ensures that all locations in the given stream have been written to the underlying storage.
      Specified by:
      ensureTranslogSynced in class Engine
      Throws:
      IOException

    • syncTranslog

      public void syncTranslog() throws IOException
      Specified by:
      syncTranslog in class Engine
      Throws:
      IOException

    • acquireHistoryRetentionLock

      public Closeable acquireHistoryRetentionLock()
      Description copied from class: Engine
      Acquires a lock on the translog files and Lucene soft-deleted documents to prevent them from being trimmed
      Specified by:
      acquireHistoryRetentionLock in class Engine

    • newChangesSnapshot

      public Translog.Snapshot newChangesSnapshot(String source, long fromSeqNo, long toSeqNo, boolean requiredFullRange, boolean accurateCount) throws IOException
      Description copied from class: Engine
      Creates a new history snapshot from Lucene for reading operations whose seqno in the requesting seqno range (both inclusive). This feature requires soft-deletes enabled. If soft-deletes are disabled, this method will throw an IllegalStateException.
      Specified by:
      newChangesSnapshot in class Engine
      Throws:
      IOException

    • newChangesSnapshotFromTranslogFile

      @Deprecated public Translog.Snapshot newChangesSnapshotFromTranslogFile(String source, long fromSeqNo, long toSeqNo, boolean requiredFullRange) throws IOException
      Deprecated.
      Description copied from class: Engine
      Reads history operations from the translog file instead of the lucene index
      Specified by:
      newChangesSnapshotFromTranslogFile in class Engine
      Throws:
      IOException

    • countNumberOfHistoryOperations

      public int countNumberOfHistoryOperations(String source, long fromSeqNo, long toSeqNumber) throws IOException
      Description copied from class: Engine
      Counts the number of history operations in the given sequence number range
      Specified by:
      countNumberOfHistoryOperations in class Engine
      Parameters:
      source - source of the request
      fromSeqNo - from sequence number; included
      toSeqNumber - to sequence number; included
      Returns:
      number of history operations
      Throws:
      IOException

    • hasCompleteOperationHistory

      public boolean hasCompleteOperationHistory(String reason, long startingSeqNo)
      Specified by:
      hasCompleteOperationHistory in class Engine

    • getMinRetainedSeqNo

      public long getMinRetainedSeqNo()
      Description copied from class: Engine
      Gets the minimum retained sequence number for this engine.
      Specified by:
      getMinRetainedSeqNo in class Engine
      Returns:
      the minimum retained sequence number

    • getTranslogStats

      public TranslogStats getTranslogStats()
      Specified by:
      getTranslogStats in class Engine

    • getTranslogLastWriteLocation

      public Translog.Location getTranslogLastWriteLocation()
      Description copied from class: Engine
      Returns the last location that the translog of this engine has written into.
      Specified by:
      getTranslogLastWriteLocation in class Engine

    • getPersistedLocalCheckpoint

      public long getPersistedLocalCheckpoint()
      Specified by:
      getPersistedLocalCheckpoint in class Engine
      Returns:
      the persisted local checkpoint for this Engine

    • getProcessedLocalCheckpoint

      public long getProcessedLocalCheckpoint()

    • getSeqNoStats

      public SeqNoStats getSeqNoStats(long globalCheckpoint)
      Specified by:
      getSeqNoStats in class Engine
      Returns:
      a SeqNoStats object, using local state and the supplied global checkpoint

    • getLastSyncedGlobalCheckpoint

      public long getLastSyncedGlobalCheckpoint()
      Description copied from class: Engine
      Returns the latest global checkpoint value that has been persisted in the underlying storage (i.e. translog's checkpoint)
      Specified by:
      getLastSyncedGlobalCheckpoint in class Engine

    • getIndexBufferRAMBytesUsed

      public long getIndexBufferRAMBytesUsed()
      Description copied from class: Engine
      How much heap is used that would be freed by a refresh. Note that this may throw AlreadyClosedException.
      Specified by:
      getIndexBufferRAMBytesUsed in class Engine

    • segments

      public List<Segment> segments(boolean verbose)
      Description copied from class: Engine
      The list of segments in the engine.
      Specified by:
      segments in class Engine

    • refresh

      public void refresh(String source) throws EngineException
      Description copied from class: Engine
      Synchronously refreshes the engine for new search operations to reflect the latest changes.
      Specified by:
      refresh in class Engine
      Throws:
      EngineException

    • maybeRefresh

      public boolean maybeRefresh(String source) throws EngineException
      Description copied from class: Engine
      Synchronously refreshes the engine for new search operations to reflect the latest changes unless another thread is already refreshing the engine concurrently.
      Specified by:
      maybeRefresh in class Engine
      Returns:
      true if the a refresh happened. Otherwise false
      Throws:
      EngineException

    • writeIndexingBuffer

      public void writeIndexingBuffer() throws EngineException
      Description copied from class: Engine
      Called when our engine is using too much heap and should move buffered indexed/deleted documents to disk.
      Specified by:
      writeIndexingBuffer in class Engine
      Throws:
      EngineException

    • shouldPeriodicallyFlush

      public boolean shouldPeriodicallyFlush()
      Description copied from class: Engine
      Checks if this engine should be flushed periodically. This check is mainly based on the uncommitted translog size and the translog flush threshold setting.
      Specified by:
      shouldPeriodicallyFlush in class Engine

    • flush

      public void flush(boolean force, boolean waitIfOngoing) throws EngineException
      Description copied from class: Engine
      Flushes the state of the engine including the transaction log, clearing memory.
      Specified by:
      flush in class Engine
      Parameters:
      force - if true a lucene commit is executed even if no changes need to be committed.
      waitIfOngoing - if true this call will block until all currently running flushes have finished. Otherwise this call will return without blocking.
      Throws:
      EngineException

    • trimUnreferencedTranslogFiles

      public void trimUnreferencedTranslogFiles() throws EngineException
      Description copied from class: Engine
      checks and removes translog files that no longer need to be retained. See TranslogDeletionPolicy for details
      Specified by:
      trimUnreferencedTranslogFiles in class Engine
      Throws:
      EngineException

    • shouldRollTranslogGeneration

      public boolean shouldRollTranslogGeneration()
      Description copied from class: Engine
      Tests whether or not the translog generation should be rolled to a new generation. This test is based on the size of the current generation compared to the configured generation threshold size.
      Specified by:
      shouldRollTranslogGeneration in class Engine
      Returns:
      true if the current generation should be rolled to a new generation

    • rollTranslogGeneration

      public void rollTranslogGeneration() throws EngineException, IOException
      Description copied from class: Engine
      Rolls the translog generation and cleans unneeded.
      Specified by:
      rollTranslogGeneration in class Engine
      Throws:
      EngineException
      IOException

    • forceMerge

      public void forceMerge(boolean flush, int maxNumSegments, boolean onlyExpungeDeletes, boolean upgrade, boolean upgradeOnlyAncientSegments, String forceMergeUUID) throws EngineException, IOException
      Description copied from class: Engine
      Triggers a forced merge on this engine
      Specified by:
      forceMerge in class Engine
      Throws:
      EngineException
      IOException

    • acquireLastIndexCommit

      public GatedCloseable<org.apache.lucene.index.IndexCommit> acquireLastIndexCommit(boolean flushFirst) throws EngineException
      Description copied from class: Engine
      Snapshots the most recent index and returns a handle to it. If needed will try and "commit" the lucene index to make sure we have a "fresh" copy of the files to snapshot.
      Specified by:
      acquireLastIndexCommit in class Engine
      Parameters:
      flushFirst - indicates whether the engine should flush before returning the snapshot
      Throws:
      EngineException

    • acquireSafeIndexCommit

      public GatedCloseable<org.apache.lucene.index.IndexCommit> acquireSafeIndexCommit() throws EngineException
      Description copied from class: Engine
      Snapshots the most recent safe index commit from the engine.
      Specified by:
      acquireSafeIndexCommit in class Engine
      Throws:
      EngineException

    • getSafeCommitInfo

      public SafeCommitInfo getSafeCommitInfo()
      Specified by:
      getSafeCommitInfo in class Engine
      Returns:
      a summary of the contents of the current safe commit

    • closeNoLock

      protected final void closeNoLock(String reason, CountDownLatch closedLatch)
      Description copied from class: Engine
      Method to close the engine while the write lock is held. Must decrement the supplied when closing work is done and resources are freed.
      Specified by:
      closeNoLock in class Engine

    • activateThrottling

      public void activateThrottling()
      Description copied from class: Engine
      Request that this engine throttle incoming indexing requests to one thread. Must be matched by a later call to Engine.deactivateThrottling().
      Specified by:
      activateThrottling in class Engine

    • deactivateThrottling

      public void deactivateThrottling()
      Description copied from class: Engine
      Reverses a previous Engine.activateThrottling() call.
      Specified by:
      deactivateThrottling in class Engine

    • restoreLocalHistoryFromTranslog

      public int restoreLocalHistoryFromTranslog(Engine.TranslogRecoveryRunner translogRecoveryRunner) throws IOException
      Description copied from class: Engine
      This method replays translog to restore the Lucene index which might be reverted previously. This ensures that all acknowledged writes are restored correctly when this engine is promoted.
      Specified by:
      restoreLocalHistoryFromTranslog in class Engine
      Returns:
      the number of translog operations have been recovered
      Throws:
      IOException

    • fillSeqNoGaps

      public int fillSeqNoGaps(long primaryTerm) throws IOException
      Description copied from class: Engine
      Fills up the local checkpoints history with no-ops until the local checkpoint and the max seen sequence ID are identical.
      Specified by:
      fillSeqNoGaps in class Engine
      Parameters:
      primaryTerm - the shards primary term this engine was created for
      Returns:
      the number of no-ops added
      Throws:
      IOException

    • recoverFromTranslog

      public Engine recoverFromTranslog(Engine.TranslogRecoveryRunner translogRecoveryRunner, long recoverUpToSeqNo) throws IOException
      Description copied from class: Engine
      Performs recovery from the transaction log up to recoverUpToSeqNo (inclusive). This operation will close the engine if the recovery fails.
      Specified by:
      recoverFromTranslog in class Engine
      Parameters:
      translogRecoveryRunner - the translog recovery runner
      recoverUpToSeqNo - the upper bound, inclusive, of sequence number to be recovered
      Throws:
      IOException

    • skipTranslogRecovery

      public void skipTranslogRecovery()
      Description copied from class: Engine
      Do not replay translog operations, but make the engine be ready.
      Specified by:
      skipTranslogRecovery in class Engine

    • maybePruneDeletes

      public void maybePruneDeletes()
      Description copied from class: Engine
      Tries to prune buffered deletes from the version map.
      Specified by:
      maybePruneDeletes in class Engine

    • updateMaxUnsafeAutoIdTimestamp

      public void updateMaxUnsafeAutoIdTimestamp(long newTimestamp)
      Description copied from class: Engine
      Forces this engine to advance its max_unsafe_auto_id_timestamp marker to at least the given timestamp. The engine will disable optimization for all append-only whose timestamp at most newTimestamp.
      Specified by:
      updateMaxUnsafeAutoIdTimestamp in class Engine

    • getMaxSeqNoOfUpdatesOrDeletes

      public long getMaxSeqNoOfUpdatesOrDeletes()
      Description copied from class: Engine
      Returns the maximum sequence number of either update or delete operations have been processed in this engine or the sequence number from Engine.advanceMaxSeqNoOfUpdatesOrDeletes(long). An index request is considered as an update operation if it overwrites the existing documents in Lucene index with the same document id.

      A note on the optimization using max_seq_no_of_updates_or_deletes: For each operation O, the key invariants are:

      1. I1: There is no operation on docID(O) with seqno that is > MSU(O) and < seqno(O)
      2. I2: If MSU(O) < seqno(O) then docID(O) did not exist when O was applied; more precisely, if there is any O' with seqno(O') < seqno(O) and docID(O') = docID(O) then the one with the greatest seqno is a delete.

      When a receiving shard (either a replica or a follower) receives an operation O, it must first ensure its own MSU at least MSU(O), and then compares its MSU to its local checkpoint (LCP). If LCP < MSU then there's a gap: there may be some operations that act on docID(O) about which we do not yet know, so we cannot perform an add. Note this also covers the case where a future operation O' with seqNo(O') > seqNo(O) and docId(O') = docID(O) is processed before O. In that case MSU(O') is at least seqno(O') and this means MSU >= seqNo(O') > seqNo(O) > LCP (because O wasn't processed yet).

      However, if MSU <= LCP then there is no gap: we have processed every operation <= LCP, and no operation O' with seqno(O') > LCP and seqno(O') < seqno(O) also has docID(O') = docID(O), because such an operation would have seqno(O') > LCP >= MSU >= MSU(O) which contradicts the first invariant. Furthermore in this case we immediately know that docID(O) has been deleted (or never existed) without needing to check Lucene for the following reason. If there's no earlier operation on docID(O) then this is clear, so suppose instead that the preceding operation on docID(O) is O': 1. The first invariant above tells us that seqno(O') <= MSU(O) <= LCP so we have already applied O' to Lucene. 2. Also MSU(O) <= MSU <= LCP < seqno(O) (we discard O if seqno(O) <= LCP) so the second invariant applies, meaning that the O' was a delete.

      Therefore, if MSU <= LCP < seqno(O) we know that O can safely be optimized with and added to lucene with addDocument. Moreover, operations that are optimized using the MSU optimization must not be processed twice as this will create duplicates in Lucene. To avoid this we check the local checkpoint tracker to see if an operation was already processed.

      Specified by:
      getMaxSeqNoOfUpdatesOrDeletes in class Engine
      See Also:

    • advanceMaxSeqNoOfUpdatesOrDeletes

      public void advanceMaxSeqNoOfUpdatesOrDeletes(long maxSeqNoOfUpdatesOnPrimary)
      Description copied from class: Engine
      A replica shard receives a new max_seq_no_of_updates from its primary shard, then calls this method to advance this marker to at least the given sequence number.
      Specified by:
      advanceMaxSeqNoOfUpdatesOrDeletes in class Engine

    • getTranslog

      public Translog getTranslog()

    • onSettingsChanged

      public void onSettingsChanged(org.opensearch.common.unit.TimeValue translogRetentionAge, org.opensearch.core.common.unit.ByteSizeValue translogRetentionSize, long softDeletesRetentionOps)
      Overrides:
      onSettingsChanged in class Engine

    • getLastCommittedSegmentInfos

      protected org.apache.lucene.index.SegmentInfos getLastCommittedSegmentInfos()
      Specified by:
      getLastCommittedSegmentInfos in class Engine

    • getLatestSegmentInfos

      protected org.apache.lucene.index.SegmentInfos getLatestSegmentInfos()
      Description copied from class: Engine
      Return the latest active SegmentInfos from the engine.
      Overrides:
      getLatestSegmentInfos in class Engine
      Returns:
      SegmentInfos

    • getSegmentInfosSnapshot

      public GatedCloseable<org.apache.lucene.index.SegmentInfos> getSegmentInfosSnapshot()
      Description copied from class: Engine
      In contrast to Engine.getLatestSegmentInfos(), which returns a SegmentInfos object directly, this method returns a GatedCloseable reference to the same object. This allows the engine to include a clean-up CheckedRunnable which is run when the reference is closed. The default implementation of the clean-up procedure is a no-op.
      Overrides:
      getSegmentInfosSnapshot in class Engine
      Returns:
      GatedCloseable - A wrapper around a SegmentInfos instance that must be closed for segment files to be deleted.

    • getLocalCheckpointTracker

      protected LocalCheckpointTracker getLocalCheckpointTracker()