[Segment Replication] Implementing cat/segment_replication API #5718
+1,530
−43
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| { | ||
| "cat.segment_replication":{ | ||
| "documentation":{ | ||
| "url":"https://github.com/opensearch-project/documentation-website/issues/2627", | ||
| "description":"Returns information about both on-going and latest completed Segment Replication events" | ||
| }, | ||
| "stability":"stable", | ||
| "url":{ | ||
| "paths":[ | ||
| { | ||
| "path":"/_cat/segment_replication", | ||
| "methods":[ | ||
| "GET" | ||
| ] | ||
| }, | ||
| { | ||
| "path":"/_cat/segment_replication/{index}", | ||
| "methods":[ | ||
| "GET" | ||
| ], | ||
| "parts":{ | ||
| "index":{ | ||
| "type":"list", | ||
| "description":"Comma-separated list or wildcard expression of index names to limit the returned information" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "params":{ | ||
| "format":{ | ||
| "type":"string", | ||
| "description":"a short version of the Accept header, e.g. json, yaml" | ||
| }, | ||
| "active_only":{ | ||
|
|
||
| "type":"boolean", | ||
| "description":"If `true`, the response only includes ongoing segment replication events", | ||
| "default":false | ||
| }, | ||
| "completed_only":{ | ||
| "type":"boolean", | ||
| "description":"If `true`, the response only includes latest completed segment replication events", | ||
| "default":false | ||
| }, | ||
| "bytes":{ | ||
| "type":"enum", | ||
| "description":"The unit in which to display byte values", | ||
| "options":[ | ||
| "b", | ||
| "k", | ||
| "kb", | ||
| "m", | ||
| "mb", | ||
| "g", | ||
| "gb", | ||
| "t", | ||
| "tb", | ||
| "p", | ||
| "pb" | ||
| ] | ||
| }, | ||
| "detailed":{ | ||
| "type":"boolean", | ||
| "description":"If `true`, the response includes detailed information about segment replications", | ||
| "default":false | ||
| }, | ||
| "shards":{ | ||
| "type":"list", | ||
| "description":"Comma-separated list of shards to display" | ||
| }, | ||
| "h":{ | ||
| "type":"list", | ||
| "description":"Comma-separated list of column names to display" | ||
| }, | ||
| "help":{ | ||
| "type":"boolean", | ||
| "description":"Return help information", | ||
| "default":false | ||
| }, | ||
| "index":{ | ||
| "type":"list", | ||
| "description":"Comma-separated list or wildcard expression of index names to limit the returned information" | ||
| }, | ||
| "s":{ | ||
| "type":"list", | ||
| "description":"Comma-separated list of column names or column aliases to sort by" | ||
| }, | ||
| "time":{ | ||
| "type":"enum", | ||
| "description":"The unit in which to display time values", | ||
| "options":[ | ||
| "d", | ||
| "h", | ||
| "m", | ||
| "s", | ||
| "ms", | ||
| "micros", | ||
| "nanos" | ||
| ] | ||
| }, | ||
| "v":{ | ||
| "type":"boolean", | ||
| "description":"Verbose mode. Display column headers", | ||
| "default":false | ||
| } | ||
| } | ||
| } | ||
| } | ||
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,154 @@ | ||
| /* | ||
| * 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.indices.replication; | ||
|
|
||
| import org.opensearch.OpenSearchStatusException; | ||
| import org.opensearch.action.admin.indices.replication.SegmentReplicationStatsResponse; | ||
| import org.opensearch.cluster.metadata.IndexMetadata; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.indices.replication.common.ReplicationType; | ||
| import org.opensearch.test.OpenSearchIntegTestCase; | ||
| import org.opensearch.test.transport.MockTransportService; | ||
| import org.opensearch.transport.TransportService; | ||
|
|
||
| import java.util.concurrent.CountDownLatch; | ||
|
|
||
| import static java.util.Arrays.asList; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.hamcrest.Matchers.greaterThan; | ||
|
|
||
| @OpenSearchIntegTestCase.ClusterScope(scope = OpenSearchIntegTestCase.Scope.TEST, numDataNodes = 0) | ||
| public class SegmentReplicationStatsIT extends SegmentReplicationBaseIT { | ||
|
|
||
| public void testSegmentReplicationStatsResponse() throws Exception { | ||
| final String primaryNode = internalCluster().startNode(); | ||
| createIndex(INDEX_NAME); | ||
| ensureYellowAndNoInitializingShards(INDEX_NAME); | ||
| final String replicaNode = internalCluster().startNode(); | ||
| ensureGreen(INDEX_NAME); | ||
|
|
||
| // index 10 docs | ||
| for (int i = 0; i < 10; i++) { | ||
| client().prepareIndex(INDEX_NAME).setId(Integer.toString(i)).setSource("field", "value" + i).execute().actionGet(); | ||
| } | ||
| refresh(INDEX_NAME); | ||
| waitForSearchableDocs(10L, asList(primaryNode, replicaNode)); | ||
|
|
||
| SegmentReplicationStatsResponse response = client().admin() | ||
| .indices() | ||
| .prepareSegmentReplicationStats(INDEX_NAME) | ||
| .execute() | ||
| .actionGet(); | ||
| // Verify API Response | ||
| assertThat(response.shardSegmentReplicationStates().size(), equalTo(SHARD_COUNT)); | ||
| assertThat(response.shardSegmentReplicationStates().get(INDEX_NAME).get(0).getStage(), equalTo(SegmentReplicationState.Stage.DONE)); | ||
| assertThat(response.shardSegmentReplicationStates().get(INDEX_NAME).get(0).getIndex().recoveredFileCount(), greaterThan(0)); | ||
| } | ||
|
|
||
| public void testSegmentReplicationStatsResponseForActiveAndCompletedOnly() throws Exception { | ||
| final String primaryNode = internalCluster().startNode(); | ||
| createIndex(INDEX_NAME); | ||
| ensureYellowAndNoInitializingShards(INDEX_NAME); | ||
| final String replicaNode = internalCluster().startNode(); | ||
| ensureGreen(INDEX_NAME); | ||
|
|
||
| // index 10 docs | ||
| for (int i = 0; i < 10; i++) { | ||
| client().prepareIndex(INDEX_NAME).setId(Integer.toString(i)).setSource("field", "value" + i).execute().actionGet(); | ||
| } | ||
| refresh(INDEX_NAME); | ||
|
|
||
| // index 10 more docs | ||
| waitForSearchableDocs(10L, asList(primaryNode, replicaNode)); | ||
| for (int i = 10; i < 20; i++) { | ||
| client().prepareIndex(INDEX_NAME).setId(Integer.toString(i)).setSource("field", "value" + i).execute().actionGet(); | ||
| } | ||
| final CountDownLatch waitForReplication = new CountDownLatch(1); | ||
|
|
||
| final CountDownLatch waitForAssertions = new CountDownLatch(1); | ||
| // Mock transport service to add behaviour of waiting in GET_SEGMENT_FILES Stage of a segment replication event. | ||
| MockTransportService mockTransportService = ((MockTransportService) internalCluster().getInstance( | ||
| TransportService.class, | ||
| replicaNode | ||
| )); | ||
| mockTransportService.addSendBehavior( | ||
| internalCluster().getInstance(TransportService.class, primaryNode), | ||
| (connection, requestId, action, request, options) -> { | ||
| if (action.equals(SegmentReplicationSourceService.Actions.GET_SEGMENT_FILES)) { | ||
| waitForReplication.countDown(); | ||
| try { | ||
| waitForAssertions.await(); | ||
| } catch (InterruptedException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
| connection.sendRequest(requestId, action, request, options); | ||
| } | ||
| ); | ||
| refresh(INDEX_NAME); | ||
| try { | ||
| waitForReplication.await(); | ||
| } catch (InterruptedException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
|
|
||
| // verifying active_only by checking if current stage is GET_FILES STAGE | ||
| SegmentReplicationStatsResponse activeOnlyResponse = client().admin() | ||
| .indices() | ||
| .prepareSegmentReplicationStats(INDEX_NAME) | ||
| .setActiveOnly(true) | ||
| .execute() | ||
| .actionGet(); | ||
| assertThat( | ||
| activeOnlyResponse.shardSegmentReplicationStates().get(INDEX_NAME).get(0).getStage(), | ||
| equalTo(SegmentReplicationState.Stage.GET_FILES) | ||
| ); | ||
|
|
||
| // verifying completed_only by checking if current stage is DONE | ||
| SegmentReplicationStatsResponse completedOnlyResponse = client().admin() | ||
| .indices() | ||
| .prepareSegmentReplicationStats(INDEX_NAME) | ||
| .setCompletedOnly(true) | ||
| .execute() | ||
| .actionGet(); | ||
| assertThat(completedOnlyResponse.shardSegmentReplicationStates().size(), equalTo(SHARD_COUNT)); | ||
| assertThat( | ||
| completedOnlyResponse.shardSegmentReplicationStates().get(INDEX_NAME).get(0).getStage(), | ||
| equalTo(SegmentReplicationState.Stage.DONE) | ||
| ); | ||
| waitForAssertions.countDown(); | ||
| } | ||
|
|
||
| public void testSegmentReplicationStatsResponseOnDocumentReplicationIndex() { | ||
| final String primaryNode = internalCluster().startNode(); | ||
| prepareCreate( | ||
| INDEX_NAME, | ||
| Settings.builder().put(IndexMetadata.SETTING_REPLICATION_TYPE, ReplicationType.DOCUMENT) | ||
|
|
||
| ).get(); | ||
| ensureYellowAndNoInitializingShards(INDEX_NAME); | ||
| final String replicaNode = internalCluster().startNode(); | ||
| ensureGreen(INDEX_NAME); | ||
|
|
||
| // index 10 docs | ||
| for (int i = 0; i < 10; i++) { | ||
| client().prepareIndex(INDEX_NAME).setId(Integer.toString(i)).setSource("field", "value" + i).execute().actionGet(); | ||
| } | ||
| refresh(INDEX_NAME); | ||
| OpenSearchStatusException exception = assertThrows( | ||
| OpenSearchStatusException.class, | ||
| () -> client().admin().indices().prepareSegmentReplicationStats(INDEX_NAME).execute().actionGet() | ||
| ); | ||
| // Verify exception message | ||
| String expectedMessage = "Segment Replication is not enabled on Index: test-idx-1"; | ||
| assertEquals(expectedMessage, exception.getMessage()); | ||
|
|
||
| } | ||
|
|
||
| } |
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.
@Rishikesh1159 Should probably make this
experimental, no?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.
Thanks @andrross for catching this. Yes I missed this, it should be
experimental. Let me make a PR to change this.