nipunbatra8 commented on code in PR #14964: URL: https://github.com/apache/lucene/pull/14964#discussion_r2308528094
########## lucene/sandbox/src/java/org/apache/lucene/sandbox/index/BandwidthCappedMergeScheduler.java: ########## @@ -0,0 +1,185 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.sandbox.index; + +import java.io.IOException; +import org.apache.lucene.index.ConcurrentMergeScheduler; +import org.apache.lucene.index.MergePolicy.OneMerge; +import org.apache.lucene.index.MergeScheduler; + +/** + * A {@link MergeScheduler} that caps total IO write bandwidth across all running merges to a + * specified max MB/sec bandwidth. + * + * @lucene.experimental + */ +public class BandwidthCappedMergeScheduler extends ConcurrentMergeScheduler { + + /** Global bandwidth cap in MB/s. Mutable so that updates are applied live. */ + private double bandwidthMbPerSec; + + /** Create a scheduler with a required global bandwidth cap in MB/s. */ + public BandwidthCappedMergeScheduler(double bandwidthMbPerSec) { + if (!(bandwidthMbPerSec > 0.0) + || Double.isNaN(bandwidthMbPerSec) + || Double.isInfinite(bandwidthMbPerSec)) { + throw new IllegalArgumentException("bandwidthMbPerSec must be a finite positive value"); + } + this.bandwidthMbPerSec = bandwidthMbPerSec; + } + + /** + * Auto IO throttling is managed by this scheduler's bandwidth cap. Enabling parent CMS IO + * throttling is ignored. + */ + @Override + public synchronized void enableAutoIOThrottle() { + if (verbose()) { + message("Ignoring enableAutoIOThrottle; using bandwidth cap instead"); + } + // Intentionally no-op + } + + /** Ensure auto IO throttling remains disabled. */ + @Override + public synchronized void disableAutoIOThrottle() { + // Make sure parent state is disabled if it was somehow enabled earlier Review Comment: The parent class has a IOThrottle that can be enabled for more efficiency. Realized it is defaulted as false in the parent class so this method and the one below are not needed because it will always be false since we disabled the enableAutoIOThrottle function. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
