forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add PUT api to update shard routing weights (opensearch-project#4272)
* Add PUT api to update shard routing weights Signed-off-by: Anshu Agarwal <anshukag@amazon.com> Signed-off-by: Vishal Sarda <vsarda@amazon.com>
- Loading branch information
Showing
18 changed files
with
1,004 additions
and
2 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
25 changes: 25 additions & 0 deletions
25
rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_weighted_routing.json
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,25 @@ | ||
| { | ||
| "cluster.put_weighted_routing": { | ||
| "documentation": { | ||
| "url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/put", | ||
| "description": "Updates weighted shard routing weights" | ||
| }, | ||
| "stability": "stable", | ||
| "url": { | ||
| "paths": [ | ||
| { | ||
| "path": "/_cluster/routing/awareness/{attribute}/weights", | ||
| "methods": [ | ||
| "PUT" | ||
| ], | ||
| "parts": { | ||
| "attribute": { | ||
| "type": "string", | ||
| "description": "Awareness attribute 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
26 changes: 26 additions & 0 deletions
26
...rch/action/admin/cluster/shards/routing/weighted/put/ClusterAddWeightedRoutingAction.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,26 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.action.admin.cluster.shards.routing.weighted.put; | ||
|
|
||
| import org.opensearch.action.ActionType; | ||
|
|
||
| /** | ||
| * Action to update weights for weighted round-robin shard routing policy. | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public final class ClusterAddWeightedRoutingAction extends ActionType<ClusterPutWeightedRoutingResponse> { | ||
|
|
||
| public static final ClusterAddWeightedRoutingAction INSTANCE = new ClusterAddWeightedRoutingAction(); | ||
| public static final String NAME = "cluster:admin/routing/awareness/weights/put"; | ||
|
|
||
| private ClusterAddWeightedRoutingAction() { | ||
| super(NAME, ClusterPutWeightedRoutingResponse::new); | ||
| } | ||
| } |
173 changes: 173 additions & 0 deletions
173
...ch/action/admin/cluster/shards/routing/weighted/put/ClusterPutWeightedRoutingRequest.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,173 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.action.admin.cluster.shards.routing.weighted.put; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.opensearch.OpenSearchGenerationException; | ||
| import org.opensearch.OpenSearchParseException; | ||
| import org.opensearch.action.ActionRequestValidationException; | ||
| import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest; | ||
| import org.opensearch.cluster.routing.WeightedRouting; | ||
| import org.opensearch.common.bytes.BytesReference; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
| import org.opensearch.common.io.stream.StreamOutput; | ||
| import org.opensearch.common.xcontent.DeprecationHandler; | ||
| import org.opensearch.common.xcontent.NamedXContentRegistry; | ||
| import org.opensearch.common.xcontent.XContentBuilder; | ||
| import org.opensearch.common.xcontent.XContentFactory; | ||
| import org.opensearch.common.xcontent.XContentHelper; | ||
| import org.opensearch.common.xcontent.XContentParser; | ||
| import org.opensearch.common.xcontent.XContentType; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
|
|
||
| import static org.opensearch.action.ValidateActions.addValidationError; | ||
|
|
||
| /** | ||
| * Request to update weights for weighted round-robin shard routing policy. | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public class ClusterPutWeightedRoutingRequest extends ClusterManagerNodeRequest<ClusterPutWeightedRoutingRequest> { | ||
| private static final Logger logger = LogManager.getLogger(ClusterPutWeightedRoutingRequest.class); | ||
|
|
||
| private WeightedRouting weightedRouting; | ||
| private String attributeName; | ||
|
|
||
| public ClusterPutWeightedRoutingRequest() {} | ||
|
|
||
| public WeightedRouting getWeightedRouting() { | ||
| return weightedRouting; | ||
| } | ||
|
|
||
| public ClusterPutWeightedRoutingRequest setWeightedRouting(WeightedRouting weightedRouting) { | ||
| this.weightedRouting = weightedRouting; | ||
| return this; | ||
| } | ||
|
|
||
| public void attributeName(String attributeName) { | ||
| this.attributeName = attributeName; | ||
| } | ||
|
|
||
| public ClusterPutWeightedRoutingRequest(StreamInput in) throws IOException { | ||
| super(in); | ||
| weightedRouting = new WeightedRouting(in); | ||
| } | ||
|
|
||
| public ClusterPutWeightedRoutingRequest(String attributeName) { | ||
| this.attributeName = attributeName; | ||
| } | ||
|
|
||
| public void setWeightedRouting(Map<String, String> source) { | ||
| try { | ||
| if (source.isEmpty()) { | ||
| throw new OpenSearchParseException(("Empty request body")); | ||
| } | ||
| XContentBuilder builder = XContentFactory.jsonBuilder(); | ||
| builder.map(source); | ||
| setWeightedRouting(BytesReference.bytes(builder), builder.contentType()); | ||
| } catch (IOException e) { | ||
| throw new OpenSearchGenerationException("Failed to generate [" + source + "]", e); | ||
| } | ||
| } | ||
|
|
||
| public void setWeightedRouting(BytesReference source, XContentType contentType) { | ||
| try ( | ||
| XContentParser parser = XContentHelper.createParser( | ||
| NamedXContentRegistry.EMPTY, | ||
| DeprecationHandler.THROW_UNSUPPORTED_OPERATION, | ||
| source, | ||
| contentType | ||
| ) | ||
| ) { | ||
| String attrValue = null; | ||
| Map<String, Double> weights = new HashMap<>(); | ||
| Double attrWeight = null; | ||
| XContentParser.Token token; | ||
| // move to the first alias | ||
| parser.nextToken(); | ||
| while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) { | ||
| if (token == XContentParser.Token.FIELD_NAME) { | ||
| attrValue = parser.currentName(); | ||
| } else if (token == XContentParser.Token.VALUE_STRING) { | ||
| attrWeight = Double.parseDouble(parser.text()); | ||
| weights.put(attrValue, attrWeight); | ||
| } else { | ||
| throw new OpenSearchParseException( | ||
| "failed to parse weighted routing request attribute [{}], " + "unknown type", | ||
| attrWeight | ||
| ); | ||
| } | ||
| } | ||
| this.weightedRouting = new WeightedRouting(this.attributeName, weights); | ||
| } catch (IOException e) { | ||
| logger.error("error while parsing put for weighted routing request object", e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| ActionRequestValidationException validationException = null; | ||
| if (weightedRouting == null) { | ||
| validationException = addValidationError("Weighted routing request object is null", validationException); | ||
| } | ||
| if (weightedRouting.attributeName() == null || weightedRouting.attributeName().isEmpty()) { | ||
| validationException = addValidationError("Attribute name is missing", validationException); | ||
| } | ||
| if (weightedRouting.weights() == null || weightedRouting.weights().isEmpty()) { | ||
| validationException = addValidationError("Weights are missing", validationException); | ||
| } | ||
| int countValueWithZeroWeights = 0; | ||
| double weight; | ||
| try { | ||
| for (Object value : weightedRouting.weights().values()) { | ||
| if (value == null) { | ||
| validationException = addValidationError(("Weight is null"), validationException); | ||
| } else { | ||
| weight = Double.parseDouble(value.toString()); | ||
| countValueWithZeroWeights = (weight == 0) ? countValueWithZeroWeights + 1 : countValueWithZeroWeights; | ||
| } | ||
| } | ||
| } catch (NumberFormatException e) { | ||
| validationException = addValidationError(("Weight is not a number"), validationException); | ||
| } | ||
| if (countValueWithZeroWeights > 1) { | ||
| validationException = addValidationError( | ||
| (String.format(Locale.ROOT, "More than one [%d] value has weight set as 0", countValueWithZeroWeights)), | ||
| validationException | ||
| ); | ||
| } | ||
| return validationException; | ||
| } | ||
|
|
||
| /** | ||
| * @param source weights definition from request body | ||
| * @return this request | ||
| */ | ||
| public ClusterPutWeightedRoutingRequest source(Map<String, String> source) { | ||
| setWeightedRouting(source); | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| super.writeTo(out); | ||
| weightedRouting.writeTo(out); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "ClusterPutWeightedRoutingRequest{" + "weightedRouting= " + weightedRouting.toString() + "}"; | ||
| } | ||
|
|
||
| } |
33 changes: 33 additions & 0 deletions
33
...on/admin/cluster/shards/routing/weighted/put/ClusterPutWeightedRoutingRequestBuilder.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,33 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.action.admin.cluster.shards.routing.weighted.put; | ||
|
|
||
| import org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder; | ||
| import org.opensearch.client.OpenSearchClient; | ||
| import org.opensearch.cluster.routing.WeightedRouting; | ||
|
|
||
| /** | ||
| * Request builder to update weights for weighted round-robin shard routing policy. | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public class ClusterPutWeightedRoutingRequestBuilder extends ClusterManagerNodeOperationRequestBuilder< | ||
| ClusterPutWeightedRoutingRequest, | ||
| ClusterPutWeightedRoutingResponse, | ||
| ClusterPutWeightedRoutingRequestBuilder> { | ||
| public ClusterPutWeightedRoutingRequestBuilder(OpenSearchClient client, ClusterAddWeightedRoutingAction action) { | ||
| super(client, action, new ClusterPutWeightedRoutingRequest()); | ||
| } | ||
|
|
||
| public ClusterPutWeightedRoutingRequestBuilder setWeightedRouting(WeightedRouting weightedRouting) { | ||
| request.setWeightedRouting(weightedRouting); | ||
| return this; | ||
| } | ||
|
|
||
| } |
29 changes: 29 additions & 0 deletions
29
...h/action/admin/cluster/shards/routing/weighted/put/ClusterPutWeightedRoutingResponse.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,29 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.action.admin.cluster.shards.routing.weighted.put; | ||
|
|
||
| import org.opensearch.action.support.master.AcknowledgedResponse; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * Response from updating weights for weighted round-robin search routing policy. | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public class ClusterPutWeightedRoutingResponse extends AcknowledgedResponse { | ||
| public ClusterPutWeightedRoutingResponse(boolean acknowledged) { | ||
| super(acknowledged); | ||
| } | ||
|
|
||
| public ClusterPutWeightedRoutingResponse(StreamInput in) throws IOException { | ||
| super(in); | ||
| } | ||
| } |
Oops, something went wrong.