-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support cancellation for admin apis (#13966)
* Support cancellation for admin apis - add implementation for _cat/shards Signed-off-by: Somesh Gupta <someshgupta987@gmail.com>
- Loading branch information
Showing
17 changed files
with
601 additions
and
42 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
129 changes: 129 additions & 0 deletions
129
...usterTest/java/org/opensearch/action/admin/cluster/shards/TransportCatShardsActionIT.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,129 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import org.opensearch.action.admin.cluster.state.ClusterStateResponse; | ||
| import org.opensearch.action.admin.indices.stats.IndicesStatsResponse; | ||
| import org.opensearch.cluster.metadata.IndexMetadata; | ||
| import org.opensearch.cluster.routing.ShardRouting; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.unit.TimeValue; | ||
| import org.opensearch.core.action.ActionListener; | ||
| import org.opensearch.core.common.Strings; | ||
| import org.opensearch.core.tasks.TaskCancelledException; | ||
| import org.opensearch.test.InternalTestCluster; | ||
| import org.opensearch.test.OpenSearchIntegTestCase; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.concurrent.CountDownLatch; | ||
|
|
||
| import static org.opensearch.cluster.routing.UnassignedInfo.INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING; | ||
| import static org.opensearch.common.unit.TimeValue.timeValueMillis; | ||
| import static org.opensearch.search.SearchService.NO_TIMEOUT; | ||
|
|
||
| @OpenSearchIntegTestCase.ClusterScope(numDataNodes = 0, scope = OpenSearchIntegTestCase.Scope.TEST) | ||
| public class TransportCatShardsActionIT extends OpenSearchIntegTestCase { | ||
|
|
||
| public void testCatShardsWithSuccessResponse() throws InterruptedException { | ||
| internalCluster().startClusterManagerOnlyNodes(1); | ||
| List<String> nodes = internalCluster().startDataOnlyNodes(3); | ||
| createIndex( | ||
| "test", | ||
| Settings.builder() | ||
| .put(IndexMetadata.SETTING_NUMBER_OF_SHARDS, 1) | ||
| .put(IndexMetadata.SETTING_NUMBER_OF_REPLICAS, 2) | ||
| .put(INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING.getKey(), "60m") | ||
| .build() | ||
| ); | ||
| ensureGreen("test"); | ||
|
|
||
| final CatShardsRequest shardsRequest = new CatShardsRequest(); | ||
| shardsRequest.setCancelAfterTimeInterval(NO_TIMEOUT); | ||
| shardsRequest.setIndices(Strings.EMPTY_ARRAY); | ||
| CountDownLatch latch = new CountDownLatch(1); | ||
| client().execute(CatShardsAction.INSTANCE, shardsRequest, new ActionListener<CatShardsResponse>() { | ||
| @Override | ||
| public void onResponse(CatShardsResponse catShardsResponse) { | ||
| ClusterStateResponse clusterStateResponse = catShardsResponse.getClusterStateResponse(); | ||
| IndicesStatsResponse indicesStatsResponse = catShardsResponse.getIndicesStatsResponse(); | ||
| for (ShardRouting shard : clusterStateResponse.getState().routingTable().allShards()) { | ||
| assertEquals("test", shard.getIndexName()); | ||
| assertNotNull(indicesStatsResponse.asMap().get(shard)); | ||
| } | ||
| latch.countDown(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onFailure(Exception e) { | ||
| fail(); | ||
| latch.countDown(); | ||
| } | ||
| }); | ||
| latch.await(); | ||
| } | ||
|
|
||
| public void testCatShardsWithTimeoutException() throws IOException, AssertionError, InterruptedException { | ||
| List<String> masterNodes = internalCluster().startClusterManagerOnlyNodes(1); | ||
| List<String> nodes = internalCluster().startDataOnlyNodes(3); | ||
| createIndex( | ||
| "test", | ||
| Settings.builder() | ||
| .put(IndexMetadata.SETTING_NUMBER_OF_SHARDS, 1) | ||
| .put(IndexMetadata.SETTING_NUMBER_OF_REPLICAS, 2) | ||
| .put(INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING.getKey(), "60m") | ||
| .build() | ||
| ); | ||
| ensureGreen("test"); | ||
|
|
||
| Settings clusterManagerDataPathSettings = internalCluster().dataPathSettings(masterNodes.get(0)); | ||
| // Dropping master node to delay in cluster state call. | ||
| internalCluster().stopRandomNode(InternalTestCluster.nameFilter(masterNodes.get(0))); | ||
|
|
||
| CountDownLatch latch = new CountDownLatch(2); | ||
| new Thread(() -> { | ||
| try { | ||
| // Ensures the cancellation timeout expires. | ||
| Thread.sleep(2000); | ||
| // Starting master node to proceed in cluster state call. | ||
| internalCluster().startClusterManagerOnlyNode( | ||
| Settings.builder().put("node.name", masterNodes.get(0)).put(clusterManagerDataPathSettings).build() | ||
| ); | ||
| latch.countDown(); | ||
| } catch (InterruptedException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| }).start(); | ||
|
|
||
| final CatShardsRequest shardsRequest = new CatShardsRequest(); | ||
| TimeValue timeoutInterval = timeValueMillis(1000); | ||
| shardsRequest.setCancelAfterTimeInterval(timeoutInterval); | ||
| shardsRequest.clusterManagerNodeTimeout(timeValueMillis(2500)); | ||
| shardsRequest.setIndices(Strings.EMPTY_ARRAY); | ||
| client().execute(CatShardsAction.INSTANCE, shardsRequest, new ActionListener<CatShardsResponse>() { | ||
| @Override | ||
| public void onResponse(CatShardsResponse catShardsResponse) { | ||
| // onResponse should not be called. | ||
| latch.countDown(); | ||
| throw new AssertionError( | ||
| "The cat shards action is expected to fail with a TaskCancelledException, but it received a successful response instead." | ||
| ); | ||
| } | ||
|
|
||
| @Override | ||
| public void onFailure(Exception e) { | ||
| assertSame(e.getClass(), TaskCancelledException.class); | ||
| assertEquals(e.getMessage(), "Cancellation timeout of " + timeoutInterval + " is expired"); | ||
| latch.countDown(); | ||
| } | ||
| }); | ||
| latch.await(); | ||
| } | ||
|
|
||
| } |
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
server/src/main/java/org/opensearch/action/admin/cluster/shards/CatShardsAction.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,25 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import org.opensearch.action.ActionType; | ||
|
|
||
| /** | ||
| * Transport action for cat shards | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public class CatShardsAction extends ActionType<CatShardsResponse> { | ||
| public static final CatShardsAction INSTANCE = new CatShardsAction(); | ||
| public static final String NAME = "cluster:monitor/shards"; | ||
|
|
||
| private CatShardsAction() { | ||
| super(NAME, CatShardsResponse::new); | ||
| } | ||
| } |
62 changes: 62 additions & 0 deletions
62
server/src/main/java/org/opensearch/action/admin/cluster/shards/CatShardsRequest.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,62 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import org.opensearch.action.ActionRequestValidationException; | ||
| import org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest; | ||
| import org.opensearch.common.unit.TimeValue; | ||
| import org.opensearch.core.common.io.stream.StreamInput; | ||
| import org.opensearch.core.tasks.TaskId; | ||
| import org.opensearch.rest.action.admin.cluster.ClusterAdminTask; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * A request of _cat/shards. | ||
| * | ||
| * @opensearch.api | ||
| */ | ||
| public class CatShardsRequest extends ClusterManagerNodeReadRequest<CatShardsRequest> { | ||
|
|
||
| private String[] indices; | ||
| private TimeValue cancelAfterTimeInterval; | ||
|
|
||
| public CatShardsRequest() {} | ||
|
|
||
| public CatShardsRequest(StreamInput in) throws IOException { | ||
| super(in); | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| return null; | ||
| } | ||
|
|
||
| public void setIndices(String[] indices) { | ||
| this.indices = indices; | ||
| } | ||
|
|
||
| public String[] getIndices() { | ||
| return this.indices; | ||
| } | ||
|
|
||
| public void setCancelAfterTimeInterval(TimeValue timeout) { | ||
| this.cancelAfterTimeInterval = timeout; | ||
| } | ||
|
|
||
| public TimeValue getCancelAfterTimeInterval() { | ||
| return this.cancelAfterTimeInterval; | ||
| } | ||
|
|
||
| @Override | ||
| public ClusterAdminTask createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) { | ||
| return new ClusterAdminTask(id, type, action, parentTaskId, headers, this.cancelAfterTimeInterval); | ||
| } | ||
| } |
57 changes: 57 additions & 0 deletions
57
server/src/main/java/org/opensearch/action/admin/cluster/shards/CatShardsResponse.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,57 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import org.opensearch.action.admin.cluster.state.ClusterStateResponse; | ||
| import org.opensearch.action.admin.indices.stats.IndicesStatsResponse; | ||
| import org.opensearch.core.action.ActionResponse; | ||
| import org.opensearch.core.common.io.stream.StreamInput; | ||
| import org.opensearch.core.common.io.stream.StreamOutput; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * A response of a cat shards request. | ||
| * | ||
| * @opensearch.api | ||
| */ | ||
| public class CatShardsResponse extends ActionResponse { | ||
|
|
||
| private ClusterStateResponse clusterStateResponse = null; | ||
|
|
||
| private IndicesStatsResponse indicesStatsResponse = null; | ||
|
|
||
| public CatShardsResponse() {} | ||
|
|
||
| public CatShardsResponse(StreamInput in) throws IOException { | ||
| super(in); | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| clusterStateResponse.writeTo(out); | ||
| indicesStatsResponse.writeTo(out); | ||
| } | ||
|
|
||
| public void setClusterStateResponse(ClusterStateResponse clusterStateResponse) { | ||
| this.clusterStateResponse = clusterStateResponse; | ||
| } | ||
|
|
||
| public ClusterStateResponse getClusterStateResponse() { | ||
| return this.clusterStateResponse; | ||
| } | ||
|
|
||
| public void setIndicesStatsResponse(IndicesStatsResponse indicesStatsResponse) { | ||
| this.indicesStatsResponse = indicesStatsResponse; | ||
| } | ||
|
|
||
| public IndicesStatsResponse getIndicesStatsResponse() { | ||
| return this.indicesStatsResponse; | ||
| } | ||
| } |
Oops, something went wrong.