- All Implemented Interfaces:
Closeable
,AutoCloseable
MergeScheduler
that runs each merge using a separate thread.
Specify the max number of threads that may run at once, and the maximum number of simultaneous
merges with setMaxMergesAndThreads(int, int)
.
If the number of merges exceeds the max number of threads then the largest merges are paused until one of the smaller merges completes.
If more than getMaxMergeCount()
merges are requested then this class will forcefully
throttle the incoming threads by pausing until one more merges complete.
This class sets defaults based on Java's view of the cpu count, and it assumes a solid state
disk (or similar). If you have a spinning disk and want to maximize performance, use setDefaultMaxMergesAndThreads(boolean)
.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
This executor provides intra-merge threads for parallel execution of merge tasks.protected class
Runs a merge thread to execute a single merge, then exits.Nested classes/interfaces inherited from class org.apache.lucene.index.MergeScheduler
MergeScheduler.MergeSource
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Dynamic default formaxThreadCount
andmaxMergeCount
, based on CPU core count.static final String
Used for testing.private boolean
true if we should rate-limit writes for each mergeprivate double
protected ConcurrentMergeScheduler.CachedExecutor
The executor provided for intra-merge parallelizationprivate static final double
Ceiling for IO write rate limit (we will never go any higher than this)private int
private int
protected int
How manyConcurrentMergeScheduler.MergeThread
s have kicked off (this is use to name them).protected final List
<ConcurrentMergeScheduler.MergeThread> List of currently activeConcurrentMergeScheduler.MergeThread
s.private static final double
Merges below this size are not counted in the maxThreadCount, i.e.private static final double
Floor for IO write rate limit (we will never go any lower than this)private static final double
Initial value for IO write rate limit when doAutoIOThrottle is trueprivate boolean
protected double
Current IO writes throttle rateFields inherited from class org.apache.lucene.index.MergeScheduler
infoStream
-
Constructor Summary
ConstructorsConstructorDescriptionSole constructor, with all settings set to default values. -
Method Summary
Modifier and TypeMethodDescriptionprivate static double
bytesToMB
(long bytes) (package private) void
Used for testingvoid
close()
Close this MergeScheduler.void
Turn off auto IO throttling.protected void
doMerge
(MergeScheduler.MergeSource mergeSource, MergePolicy.OneMerge merge) Does the actual merge, by callingMergeScheduler.MergeSource.merge(org.apache.lucene.index.MergePolicy.OneMerge)
protected void
doStall()
Called frommaybeStall(org.apache.lucene.index.MergeScheduler.MergeSource)
to pause the calling thread for a bit.void
Turn on dynamic IO throttling, to adaptively rate limit writes bytes/sec to the minimal rate necessary so merges do not fall behind.boolean
Returns true if auto IO throttling is currently enabled.double
Get the per-merge IO throttle rate for forced merges.Provides an executor for parallelism during a single merge operation.double
Returns the currently set per-merge IO writes rate limit, ifenableAutoIOThrottle()
was called, elseDouble.POSITIVE_INFINITY
.int
int
ReturnsmaxThreadCount
.protected ConcurrentMergeScheduler.MergeThread
getMergeThread
(MergeScheduler.MergeSource mergeSource, MergePolicy.OneMerge merge) Create and return a new MergeThreadprivate static String
protected void
Called when an exception is hit in a background merge threadprivate void
initDynamicDefaults
(Directory directory) (package private) void
initialize
(InfoStream infoStream, Directory directory) IndexWriter calls this on init.private boolean
isBacklog
(long now, MergePolicy.OneMerge merge) protected boolean
maybeStall
(MergeScheduler.MergeSource mergeSource) This is invoked bymerge(org.apache.lucene.index.MergeScheduler.MergeSource, org.apache.lucene.index.MergeTrigger)
to possibly stall the incoming thread when there are too many merges running or pending.void
merge
(MergeScheduler.MergeSource mergeSource, MergeTrigger trigger) Run the merges provided byMergeScheduler.MergeSource.getNextMerge()
.int
Returns the number of merge threads that are alive, ignoring the calling thread if it is a merge thread.private static double
nsToSec
(long ns) private static String
rateToString
(double mbPerSec) (package private) void
Removes the calling thread from the active merge threads.(package private) void
runOnMergeFinished
(MergeScheduler.MergeSource mergeSource) void
setDefaultMaxMergesAndThreads
(boolean spins) Sets max merges and threads to proper defaults for rotational or non-rotational storage.void
setForceMergeMBPerSec
(double v) Set the per-merge IO throttle rate for forced merges (default:Double.POSITIVE_INFINITY
).void
setMaxMergesAndThreads
(int maxMergeCount, int maxThreadCount) Expert: directly set the maximum number of merge threads and simultaneous merges allowed.(package private) void
Used for testingvoid
sync()
Wait for any running merge threads to finish.protected void
Subclass can override to tweak targetMBPerSec.toString()
private void
updateIOThrottle
(MergePolicy.OneMerge newMerge, MergeRateLimiter rateLimiter) Tunes IO throttle when a new merge starts.protected void
Called whenever the running merges have changed, to set merge IO limits.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) Wraps the incomingDirectory
so that we can merge-throttle it usingRateLimitedIndexOutput
.Methods inherited from class org.apache.lucene.index.MergeScheduler
message, verbose
-
Field Details
-
AUTO_DETECT_MERGES_AND_THREADS
public static final int AUTO_DETECT_MERGES_AND_THREADSDynamic default formaxThreadCount
andmaxMergeCount
, based on CPU core count.maxThreadCount
is set tomax(1, min(4, cpuCoreCount/2))
.maxMergeCount
is set tomaxThreadCount + 5
.- See Also:
-
DEFAULT_CPU_CORE_COUNT_PROPERTY
Used for testing.- See Also:
-
mergeThreads
List of currently activeConcurrentMergeScheduler.MergeThread
s. -
maxThreadCount
private int maxThreadCount -
maxMergeCount
private int maxMergeCount -
mergeThreadCount
protected int mergeThreadCountHow manyConcurrentMergeScheduler.MergeThread
s have kicked off (this is use to name them). -
MIN_MERGE_MB_PER_SEC
private static final double MIN_MERGE_MB_PER_SECFloor for IO write rate limit (we will never go any lower than this)- See Also:
-
MAX_MERGE_MB_PER_SEC
private static final double MAX_MERGE_MB_PER_SECCeiling for IO write rate limit (we will never go any higher than this)- See Also:
-
START_MB_PER_SEC
private static final double START_MB_PER_SECInitial value for IO write rate limit when doAutoIOThrottle is true- See Also:
-
MIN_BIG_MERGE_MB
private static final double MIN_BIG_MERGE_MBMerges below this size are not counted in the maxThreadCount, i.e. they can freely run in their own thread (up until maxMergeCount).- See Also:
-
targetMBPerSec
protected double targetMBPerSecCurrent IO writes throttle rate -
doAutoIOThrottle
private boolean doAutoIOThrottletrue if we should rate-limit writes for each merge -
forceMergeMBPerSec
private double forceMergeMBPerSec -
intraMergeExecutor
The executor provided for intra-merge parallelization -
suppressExceptions
private boolean suppressExceptions
-
-
Constructor Details
-
ConcurrentMergeScheduler
public ConcurrentMergeScheduler()Sole constructor, with all settings set to default values.
-
-
Method Details
-
setMaxMergesAndThreads
public void setMaxMergesAndThreads(int maxMergeCount, int maxThreadCount) Expert: directly set the maximum number of merge threads and simultaneous merges allowed.- Parameters:
maxMergeCount
- the max # simultaneous merges that are allowed. If a merge is necessary yet we already have this many threads running, the incoming thread (that is calling add/updateDocument) will block until a merge thread has completed. Note that we will only run the smallestmaxThreadCount
merges at a time.maxThreadCount
- the max # simultaneous merge threads that should be running at once. This must be <=maxMergeCount
-
setDefaultMaxMergesAndThreads
public void setDefaultMaxMergesAndThreads(boolean spins) Sets max merges and threads to proper defaults for rotational or non-rotational storage.- Parameters:
spins
- true to set defaults best for traditional rotatational storage (spinning disks), else false (e.g. for solid-state disks)
-
setForceMergeMBPerSec
public void setForceMergeMBPerSec(double v) Set the per-merge IO throttle rate for forced merges (default:Double.POSITIVE_INFINITY
). -
getForceMergeMBPerSec
public double getForceMergeMBPerSec()Get the per-merge IO throttle rate for forced merges. -
enableAutoIOThrottle
public void enableAutoIOThrottle()Turn on dynamic IO throttling, to adaptively rate limit writes bytes/sec to the minimal rate necessary so merges do not fall behind. By default this is enabled. -
disableAutoIOThrottle
public void disableAutoIOThrottle()Turn off auto IO throttling.- See Also:
-
getAutoIOThrottle
public boolean getAutoIOThrottle()Returns true if auto IO throttling is currently enabled. -
getIORateLimitMBPerSec
public double getIORateLimitMBPerSec()Returns the currently set per-merge IO writes rate limit, ifenableAutoIOThrottle()
was called, elseDouble.POSITIVE_INFINITY
. -
getMaxThreadCount
public int getMaxThreadCount()ReturnsmaxThreadCount
.- See Also:
-
getMaxMergeCount
public int getMaxMergeCount() -
removeMergeThread
void removeMergeThread()Removes the calling thread from the active merge threads. -
getIntraMergeExecutor
Description copied from class:MergeScheduler
Provides an executor for parallelism during a single merge operation. By default, the method returns aSameThreadExecutorService
where all intra-merge actions occur in their calling thread.- Overrides:
getIntraMergeExecutor
in classMergeScheduler
-
wrapForMerge
Description copied from class:MergeScheduler
Wraps the incomingDirectory
so that we can merge-throttle it usingRateLimitedIndexOutput
.- Overrides:
wrapForMerge
in classMergeScheduler
-
updateMergeThreads
protected void updateMergeThreads()Called whenever the running merges have changed, to set merge IO limits. This method sorts the merge threads by their merge size in descending order and then pauses/unpauses threads from first to last -- that way, smaller merges are guaranteed to run before larger ones. -
initDynamicDefaults
- Throws:
IOException
-
rateToString
-
close
Description copied from class:MergeScheduler
Close this MergeScheduler.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classMergeScheduler
- Throws:
IOException
-
sync
public void sync()Wait for any running merge threads to finish. This call is not interruptible as used byclose()
. -
mergeThreadCount
public int mergeThreadCount()Returns the number of merge threads that are alive, ignoring the calling thread if it is a merge thread. Note that this number is ≤mergeThreads
size. -
initialize
Description copied from class:MergeScheduler
IndexWriter calls this on init.- Overrides:
initialize
in classMergeScheduler
- Throws:
IOException
-
merge
Description copied from class:MergeScheduler
Run the merges provided byMergeScheduler.MergeSource.getNextMerge()
.- Specified by:
merge
in classMergeScheduler
- Parameters:
mergeSource
- theIndexWriter
to obtain the merges from.trigger
- theMergeTrigger
that caused this merge to happen- Throws:
IOException
-
maybeStall
This is invoked bymerge(org.apache.lucene.index.MergeScheduler.MergeSource, org.apache.lucene.index.MergeTrigger)
to possibly stall the incoming thread when there are too many merges running or pending. The default behavior is to force this thread, which is producing too many segments for merging to keep up, to wait until merges catch up. Applications that can take other less drastic measures, such as limiting how many threads are allowed to index, can do nothing here and throttle elsewhere.If this method wants to stall but the calling thread is a merge thread, it should return false to tell caller not to kick off any new merges.
-
doStall
protected void doStall()Called frommaybeStall(org.apache.lucene.index.MergeScheduler.MergeSource)
to pause the calling thread for a bit. -
doMerge
protected void doMerge(MergeScheduler.MergeSource mergeSource, MergePolicy.OneMerge merge) throws IOException Does the actual merge, by callingMergeScheduler.MergeSource.merge(org.apache.lucene.index.MergePolicy.OneMerge)
- Throws:
IOException
-
getMergeThread
protected ConcurrentMergeScheduler.MergeThread getMergeThread(MergeScheduler.MergeSource mergeSource, MergePolicy.OneMerge merge) throws IOException Create and return a new MergeThread- Throws:
IOException
-
runOnMergeFinished
-
handleMergeException
Called when an exception is hit in a background merge thread -
setSuppressExceptions
void setSuppressExceptions()Used for testing -
clearSuppressExceptions
void clearSuppressExceptions()Used for testing -
toString
-
isBacklog
-
updateIOThrottle
private void updateIOThrottle(MergePolicy.OneMerge newMerge, MergeRateLimiter rateLimiter) throws IOException Tunes IO throttle when a new merge starts.- Throws:
IOException
-
targetMBPerSecChanged
protected void targetMBPerSecChanged()Subclass can override to tweak targetMBPerSec. -
nsToSec
private static double nsToSec(long ns) -
bytesToMB
private static double bytesToMB(long bytes) -
getSegmentName
-