-
Notifications
You must be signed in to change notification settings - Fork 24.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
add throttling to transform, throttling will slow down search requests by delaying the execution based on a documents per second metric. fixes #54862
- Loading branch information
Hendrik Muhs
authored
May 5, 2020
1 parent
f569405
commit e177a38
Showing
41 changed files
with
2,075 additions
and
552 deletions.
There are no files selected for viewing
150 changes: 150 additions & 0 deletions
150
...igh-level/src/main/java/org/elasticsearch/client/transform/transforms/SettingsConfig.java
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,150 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.client.transform.transforms; | ||
|
|
||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Objects; | ||
|
|
||
| import static org.elasticsearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; | ||
|
|
||
| public class SettingsConfig implements ToXContentObject { | ||
|
|
||
| private static final ParseField MAX_PAGE_SEARCH_SIZE = new ParseField("max_page_search_size"); | ||
| private static final ParseField DOCS_PER_SECOND = new ParseField("docs_per_second"); | ||
| private static final int DEFAULT_MAX_PAGE_SEARCH_SIZE = -1; | ||
| private static final float DEFAULT_DOCS_PER_SECOND = -1F; | ||
|
|
||
| private final Integer maxPageSearchSize; | ||
| private final Float docsPerSecond; | ||
|
|
||
| private static final ConstructingObjectParser<SettingsConfig, Void> PARSER = new ConstructingObjectParser<>( | ||
| "settings_config", | ||
| true, | ||
| args -> new SettingsConfig((Integer) args[0], (Float) args[1]) | ||
| ); | ||
|
|
||
| static { | ||
| PARSER.declareIntOrNull(optionalConstructorArg(), DEFAULT_MAX_PAGE_SEARCH_SIZE, MAX_PAGE_SEARCH_SIZE); | ||
| PARSER.declareFloatOrNull(optionalConstructorArg(), DEFAULT_DOCS_PER_SECOND, DOCS_PER_SECOND); | ||
| } | ||
|
|
||
| public static SettingsConfig fromXContent(final XContentParser parser) { | ||
| return PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| SettingsConfig(Integer maxPageSearchSize, Float docsPerSecond) { | ||
| this.maxPageSearchSize = maxPageSearchSize; | ||
| this.docsPerSecond = docsPerSecond; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| if (maxPageSearchSize != null) { | ||
| if (maxPageSearchSize.equals(DEFAULT_MAX_PAGE_SEARCH_SIZE)) { | ||
| builder.field(MAX_PAGE_SEARCH_SIZE.getPreferredName(), (Integer) null); | ||
| } else { | ||
| builder.field(MAX_PAGE_SEARCH_SIZE.getPreferredName(), maxPageSearchSize); | ||
| } | ||
| } | ||
| if (docsPerSecond != null) { | ||
| if (docsPerSecond.equals(DEFAULT_DOCS_PER_SECOND)) { | ||
| builder.field(DOCS_PER_SECOND.getPreferredName(), (Float) null); | ||
| } else { | ||
| builder.field(DOCS_PER_SECOND.getPreferredName(), docsPerSecond); | ||
| } | ||
| } | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| public Integer getMaxPageSearchSize() { | ||
| return maxPageSearchSize; | ||
| } | ||
|
|
||
| public Float getDocsPerSecond() { | ||
| return docsPerSecond; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object other) { | ||
| if (other == this) { | ||
| return true; | ||
| } | ||
| if (other == null || other.getClass() != getClass()) { | ||
| return false; | ||
| } | ||
|
|
||
| SettingsConfig that = (SettingsConfig) other; | ||
| return Objects.equals(maxPageSearchSize, that.maxPageSearchSize) && Objects.equals(docsPerSecond, that.docsPerSecond); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(maxPageSearchSize, docsPerSecond); | ||
| } | ||
|
|
||
| public static Builder builder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| public static class Builder { | ||
| private Integer maxPageSearchSize; | ||
| private Float docsPerSecond; | ||
|
|
||
| /** | ||
| * Sets the paging maximum paging maxPageSearchSize that transform can use when | ||
| * pulling the data from the source index. | ||
| * | ||
| * If OOM is triggered, the paging maxPageSearchSize is dynamically reduced so that the transform can continue to gather data. | ||
| * | ||
| * @param maxPageSearchSize Integer value between 10 and 10_000 | ||
| * @return the {@link Builder} with the paging maxPageSearchSize set. | ||
| */ | ||
| public Builder setMaxPageSearchSize(Integer maxPageSearchSize) { | ||
| this.maxPageSearchSize = maxPageSearchSize == null ? DEFAULT_MAX_PAGE_SEARCH_SIZE : maxPageSearchSize; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the docs per second that transform can use when pulling the data from the source index. | ||
| * | ||
| * This setting throttles transform by issuing queries less often, however processing still happens in | ||
| * batches. A value of 0 disables throttling (default). | ||
| * | ||
| * @param docsPerSecond Integer value | ||
| * @return the {@link Builder} with requestsPerSecond set. | ||
| */ | ||
| public Builder setRequestsPerSecond(Float docsPerSecond) { | ||
| this.docsPerSecond = docsPerSecond == null ? DEFAULT_DOCS_PER_SECOND : docsPerSecond; | ||
| return this; | ||
| } | ||
|
|
||
| public SettingsConfig build() { | ||
| return new SettingsConfig(maxPageSearchSize, docsPerSecond); | ||
| } | ||
| } | ||
| } |
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.