Skip to content

Apache Lucene open-source search software

Expose MergeRateLimiter in runOnMergeFinished hook (#15507)

Zihan Xu5ccd5ccfd9be
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 14d1ab2cd49..574a16725b1 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -56,6 +56,12 @@ API Changes
* GITHUB#14615 : Remove unnecessary public methods in FuzzySet (Greg Miller)
+* GITHUB#15507: Expose MergeRateLimiter in ConcurrentMergeScheduler.runOnMergeFinished hook.
+ The runOnMergeFinished method signature now includes OneMerge and MergeRateLimiter parameters,
+ enabling applications to monitor merge performance metrics like pause time, throttling behavior,
+ and throughput. This provides visibility into Lucene's merge backpressure mechanisms that can
+ stall indexing when merge debt accumulates. (Zihan Xu)
+
New Features
---------------------
diff --git a/lucene/core/src/java/org/apache/lucene/index/ConcurrentMergeScheduler.java b/lucene/core/src/java/org/apache/lucene/index/ConcurrentMergeScheduler.java
index 39a7ff3a401..94b4508b984 100644
--- a/lucene/core/src/java/org/apache/lucene/index/ConcurrentMergeScheduler.java
+++ b/lucene/core/src/java/org/apache/lucene/index/ConcurrentMergeScheduler.java
@@ -670,7 +670,13 @@ public class ConcurrentMergeScheduler extends MergeScheduler {
return thread;
}
- synchronized void runOnMergeFinished(MergeSource mergeSource) {
+ /**
+ * Called when a merge thread finishes.
+ *
+ * @lucene.experimental
+ */
+ protected synchronized void runOnMergeFinished(
+ MergeSource mergeSource, OneMerge merge, MergeRateLimiter rateLimiter) {
// the merge call as well as the merge thread handling in the finally
// block must be sync'd on CMS otherwise stalling decisions might cause
// us to miss pending merges
@@ -733,7 +739,7 @@ public class ConcurrentMergeScheduler extends MergeScheduler {
rateToString(rateLimiter.getMBPerSec())));
}
- runOnMergeFinished(mergeSource);
+ runOnMergeFinished(mergeSource, merge, rateLimiter);
if (verbose()) {
message(String.format(Locale.ROOT, "merge thread %s end", this.getName()));