-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add set_priority action to ILM (#37397)
This commit adds a set_priority action to the hot, warm, and cold phases for an ILM policy. This action sets the `index.priority` on the managed index to allow different priorities between the hot, warm, and cold recoveries. This commit also includes the HLRC and documentation changes. closes #36905
- Loading branch information
1 parent
20ed3dd
commit 587034d
Showing
21 changed files
with
547 additions
and
34 deletions.
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
96 changes: 96 additions & 0 deletions
96
...t-high-level/src/main/java/org/elasticsearch/client/indexlifecycle/SetPriorityAction.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,96 @@ | ||
| /* | ||
| * 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.indexlifecycle; | ||
|
|
||
| import org.elasticsearch.common.Nullable; | ||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.ToXContent; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * A {@link LifecycleAction} which sets the index's priority. The higher the priority, the faster the recovery. | ||
| */ | ||
| public class SetPriorityAction implements LifecycleAction, ToXContentObject { | ||
| public static final String NAME = "set_priority"; | ||
| private static final ParseField RECOVERY_PRIORITY_FIELD = new ParseField("priority"); | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static final ConstructingObjectParser<SetPriorityAction, Void> PARSER = new ConstructingObjectParser<>(NAME, true, | ||
| a -> new SetPriorityAction((Integer) a[0])); | ||
|
|
||
| //package private for testing | ||
| final Integer recoveryPriority; | ||
|
|
||
| static { | ||
| PARSER.declareField(ConstructingObjectParser.constructorArg(), | ||
| (p) -> p.currentToken() == XContentParser.Token.VALUE_NULL ? null : p.intValue() | ||
| , RECOVERY_PRIORITY_FIELD, ObjectParser.ValueType.INT_OR_NULL); | ||
| } | ||
|
|
||
| public static SetPriorityAction parse(XContentParser parser) { | ||
| return PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| public SetPriorityAction(@Nullable Integer recoveryPriority) { | ||
| if (recoveryPriority != null && recoveryPriority <= 0) { | ||
| throw new IllegalArgumentException("[" + RECOVERY_PRIORITY_FIELD.getPreferredName() + "] must be 0 or greater"); | ||
| } | ||
| this.recoveryPriority = recoveryPriority; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field(RECOVERY_PRIORITY_FIELD.getPreferredName(), recoveryPriority); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
|
|
||
| SetPriorityAction that = (SetPriorityAction) o; | ||
|
|
||
| return recoveryPriority != null ? recoveryPriority.equals(that.recoveryPriority) : that.recoveryPriority == null; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return recoveryPriority != null ? recoveryPriority.hashCode() : 0; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return Strings.toString(this); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return NAME; | ||
| } | ||
| } |
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
71 changes: 71 additions & 0 deletions
71
...h-level/src/test/java/org/elasticsearch/client/indexlifecycle/SetPriorityActionTests.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,71 @@ | ||
| /* | ||
| * 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.indexlifecycle; | ||
|
|
||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.test.AbstractXContentTestCase; | ||
| import org.elasticsearch.test.EqualsHashCodeTestUtils; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import static org.hamcrest.Matchers.equalTo; | ||
|
|
||
| public class SetPriorityActionTests extends AbstractXContentTestCase<SetPriorityAction> { | ||
|
|
||
| @Override | ||
| protected SetPriorityAction doParseInstance(XContentParser parser) throws IOException { | ||
| return SetPriorityAction.parse(parser); | ||
| } | ||
|
|
||
| @Override | ||
| protected SetPriorityAction createTestInstance() { | ||
| return randomInstance(); | ||
| } | ||
|
|
||
| static SetPriorityAction randomInstance() { | ||
| return new SetPriorityAction(randomIntBetween(1, 100)); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean supportsUnknownFields() { | ||
| return false; | ||
| } | ||
|
|
||
| public void testNonPositivePriority() { | ||
| Exception e = expectThrows(Exception.class, () -> new SetPriorityAction(randomIntBetween(-100, 0))); | ||
| assertThat(e.getMessage(), equalTo("[priority] must be 0 or greater")); | ||
| } | ||
|
|
||
| public void testNullPriorityAllowed(){ | ||
| SetPriorityAction nullPriority = new SetPriorityAction(null); | ||
| assertNull(nullPriority.recoveryPriority); | ||
| } | ||
|
|
||
| public void testEqualsAndHashCode() { | ||
| EqualsHashCodeTestUtils.checkEqualsAndHashCode(createTestInstance(), this::copy); | ||
| } | ||
|
|
||
| SetPriorityAction copy(SetPriorityAction setPriorityAction) { | ||
| return new SetPriorityAction(setPriorityAction.recoveryPriority); | ||
| } | ||
|
|
||
| SetPriorityAction notCopy(SetPriorityAction setPriorityAction) { | ||
| return new SetPriorityAction(setPriorityAction.recoveryPriority + 1); | ||
| } | ||
| } |
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
Oops, something went wrong.