Adaptive rate limiting for OpenSearch bulk requests #1011
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.flint.core.storage; | ||
|
|
||
| import com.google.common.util.concurrent.RateLimiter; | ||
| import java.util.logging.Logger; | ||
| import org.opensearch.flint.core.FlintOptions; | ||
| import org.opensearch.flint.core.metrics.MetricConstants; | ||
| import org.opensearch.flint.core.metrics.MetricsUtil; | ||
|
|
||
| public class BulkRequestRateLimiterImpl implements BulkRequestRateLimiter { | ||
| private static final Logger LOG = Logger.getLogger(BulkRequestRateLimiterImpl.class.getName()); | ||
| private RateLimiter rateLimiter; | ||
|
|
||
| private final long minRate; | ||
| private final long maxRate; | ||
| private final long increaseStep; | ||
| private final double decreaseRatio; | ||
|
|
||
| public BulkRequestRateLimiterImpl(FlintOptions flintOptions) { | ||
| minRate = flintOptions.getBulkRequestMinRateLimitPerNode(); | ||
| maxRate = flintOptions.getBulkRequestMaxRateLimitPerNode(); | ||
| increaseStep = flintOptions.getBulkRequestRateLimitPerNodeIncreaseStep(); | ||
| decreaseRatio = flintOptions.getBulkRequestRateLimitPerNodeDecreaseRatio(); | ||
|
|
||
| LOG.info("Setting rate limit for bulk request to " + minRate + " documents/sec"); | ||
| this.rateLimiter = RateLimiter.create(minRate); | ||
| MetricsUtil.addHistoricGauge(MetricConstants.OS_BULK_RATE_LIMIT_METRIC, minRate); | ||
| } | ||
|
|
||
| // Wait so it won't exceed rate limit. Does nothing if rate limit is not set. | ||
| @Override | ||
| public void acquirePermit() { | ||
| this.rateLimiter.acquire(); | ||
| LOG.info("Acquired 1 permit"); | ||
| } | ||
|
|
||
| @Override | ||
| public void acquirePermit(int permits) { | ||
| this.rateLimiter.acquire(permits); | ||
| LOG.info("Acquired " + permits + " permits"); | ||
| } | ||
|
|
||
| /** | ||
| * Increase rate limit additively. | ||
| */ | ||
| @Override | ||
| public void increaseRate() { | ||
| setRate(getRate() + increaseStep); | ||
| } | ||
|
|
||
| /** | ||
| * Decrease rate limit multiplicatively. | ||
| */ | ||
| @Override | ||
| public void decreaseRate() { | ||
| setRate((long) (getRate() * decreaseRatio)); | ||
| } | ||
|
|
||
| @Override | ||
| public long getRate() { | ||
| return (long) this.rateLimiter.getRate(); | ||
| } | ||
|
|
||
| /** | ||
| * Set rate limit to the given value, clamped by minRate and maxRate. Non-positive maxRate means | ||
| * there's no maximum rate restriction, and the rate can be set to any value greater than | ||
| * minRate. | ||
| */ | ||
| @Override | ||
| public void setRate(long permitsPerSecond) { | ||
| if (maxRate > 0) { | ||
| permitsPerSecond = Math.min(permitsPerSecond, maxRate); | ||
| } | ||
| permitsPerSecond = Math.max(minRate, permitsPerSecond); | ||
| LOG.info("Setting rate limit for bulk request to " + permitsPerSecond + " documents/sec"); | ||
| this.rateLimiter.setRate(permitsPerSecond); | ||
| MetricsUtil.addHistoricGauge(MetricConstants.OS_BULK_RATE_LIMIT_METRIC, permitsPerSecond); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.flint.core.storage; | ||
|
|
||
| import java.util.logging.Logger; | ||
|
|
||
| public class BulkRequestRateLimiterNoop implements BulkRequestRateLimiter { | ||
| private static final Logger LOG = Logger.getLogger(BulkRequestRateLimiterNoop.class.getName()); | ||
|
|
||
| public BulkRequestRateLimiterNoop() { | ||
| LOG.info("Rate limit for bulk request was not set."); | ||
| } | ||
|
|
||
| @Override | ||
| public void acquirePermit() {} | ||
|
|
||
| @Override | ||
| public void acquirePermit(int permits) {} | ||
|
|
||
| @Override | ||
| public void increaseRate() {} | ||
|
|
||
| @Override | ||
| public void decreaseRate() {} | ||
|
|
||
| @Override | ||
| public long getRate() { | ||
| return 0; | ||
| } | ||
|
|
||
| @Override | ||
| public void setRate(long permitsPerSecond) {} | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure what is the main purpose of having min value? is there any concerns if the rate limiter goes down to zero incase of continuous failures?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For one, min value is used for initial rate limit.
Second is that rate could only increase if there's some successful request, so we can't have 0 rate limit, or else it wouldn't bounce back at all.
Having too small of a rate could also be troublesome, because that means the rate limiter will react slower. For example, say the rate limit becomes 10 docs per sec, however a single request consists of 1000 docs. Then once the 1000 docs request go through, there'll be 100 seconds where other requests couldn't go through (so it satisfy the 10 doc per sec rate). That's 100 seconds of not updating the rate.