[Segment Replication] Implementing cat/segment_replication API #5718
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| { | ||
| "cat.segment_replication":{ | ||
| "documentation":{ | ||
| "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segment_replication.html", | ||
| "description":"Returns information about index Segment Replication events, both on-going and completed." | ||
|
|
||
| }, | ||
| "stability":"stable", | ||
|
There was a problem hiding this comment. @Rishikesh1159 Should probably make this There was a problem hiding this comment. Thanks @andrross for catching this. Yes I missed this, it should be |
||
| "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 replications", | ||
| "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 | ||
| }, | ||
| "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
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,20 @@ | ||
| /* | ||
| * 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.indices.segment_replication; | ||
|
|
||
| import org.opensearch.action.ActionType; | ||
|
|
||
| public class SegmentReplicationAction extends ActionType<SegmentReplicationResponse> { | ||
|
There was a problem hiding this comment. Nit: might need a javadoc/comment here There was a problem hiding this comment. Added in latest commit There was a problem hiding this comment. nit - Naming doesn't indicate this is about stats. What about SegmentReplicationStatsAction/Response ? There was a problem hiding this comment. Yes SegmentReplicationStatsAction makes sense. I will update that in next commit |
||
| public static final SegmentReplicationAction INSTANCE = new SegmentReplicationAction(); | ||
| public static final String NAME = "indices:monitor/segment_replication"; | ||
|
|
||
| private SegmentReplicationAction() { | ||
| super(NAME, SegmentReplicationResponse::new); | ||
| } | ||
| } | ||
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,89 @@ | ||
| /* | ||
| * 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.indices.segment_replication; | ||
|
|
||
| import org.opensearch.action.support.IndicesOptions; | ||
| import org.opensearch.action.support.broadcast.BroadcastRequest; | ||
| import org.opensearch.common.Strings; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
| import org.opensearch.common.io.stream.StreamOutput; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| public class SegmentReplicationRequest extends BroadcastRequest<SegmentReplicationRequest> { | ||
|
There was a problem hiding this comment. Nit: javadocs/comments There was a problem hiding this comment. Added in latest commit |
||
| private boolean detailed = false; // Provides extra details in the response | ||
| private boolean activeOnly = false; // Only reports on active recoveries | ||
|
|
||
| /** | ||
| * Constructs a request for segment replication information for all shards | ||
| */ | ||
| public SegmentReplicationRequest() { | ||
| this(Strings.EMPTY_ARRAY); | ||
| } | ||
|
|
||
| public SegmentReplicationRequest(StreamInput in) throws IOException { | ||
| super(in); | ||
| detailed = in.readBoolean(); | ||
| activeOnly = in.readBoolean(); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a request for segment replication information for all shards for the given indices | ||
| * | ||
| * @param indices Comma-separated list of indices about which to gather segment replication information | ||
| */ | ||
| public SegmentReplicationRequest(String... indices) { | ||
| super(indices, IndicesOptions.STRICT_EXPAND_OPEN_CLOSED); | ||
| } | ||
|
|
||
| /** | ||
| * True if detailed flag is set, false otherwise. This value if false by default. | ||
| * | ||
| * @return True if detailed flag is set, false otherwise | ||
| */ | ||
| public boolean detailed() { | ||
| return detailed; | ||
| } | ||
|
|
||
| /** | ||
| * Set value of the detailed flag. Detailed requests will contain extra | ||
| * information. | ||
|
There was a problem hiding this comment. Might be more helpful to mention exactly what this detailed information will be. Could be included in the help message for detailed flag. There was a problem hiding this comment. Sure I have added that in latest commit, detailed information will be timing metric of each stage of segment replication event. Sure, I will try to add this in help message in next commit |
||
| * | ||
| * @param detailed Whether or not to set the detailed flag | ||
| */ | ||
| public void detailed(boolean detailed) { | ||
| this.detailed = detailed; | ||
| } | ||
|
|
||
| /** | ||
| * True if activeOnly flag is set, false otherwise. This value is false by default. | ||
| * | ||
| * @return True if activeOnly flag is set, false otherwise | ||
| */ | ||
| public boolean activeOnly() { | ||
| return activeOnly; | ||
| } | ||
|
|
||
| /** | ||
| * Set value of the activeOnly flag. If true, this request will only response with | ||
|
There was a problem hiding this comment. Fixed in latest commit |
||
| * on-going recovery information. | ||
| * | ||
| * @param activeOnly Whether or not to set the activeOnly flag. | ||
| */ | ||
| public void activeOnly(boolean activeOnly) { | ||
| this.activeOnly = activeOnly; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| super.writeTo(out); | ||
| out.writeBoolean(detailed); | ||
| out.writeBoolean(activeOnly); | ||
| } | ||
| } | ||
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.indices.segment_replication; | ||
|
|
||
| import org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder; | ||
| import org.opensearch.client.OpenSearchClient; | ||
|
|
||
| public class SegmentReplicationRequestBuilder extends BroadcastOperationRequestBuilder< | ||
|
There was a problem hiding this comment. I think some javadocs/comments might be useful here. There was a problem hiding this comment. Added in latest commit |
||
| SegmentReplicationRequest, | ||
| SegmentReplicationResponse, | ||
| SegmentReplicationRequestBuilder> { | ||
|
|
||
| public SegmentReplicationRequestBuilder(OpenSearchClient client, SegmentReplicationAction action) { | ||
| super(client, action, new SegmentReplicationRequest()); | ||
| } | ||
|
|
||
| public SegmentReplicationRequestBuilder setDetailed(boolean detailed) { | ||
| request.detailed(detailed); | ||
| return this; | ||
| } | ||
|
|
||
| public SegmentReplicationRequestBuilder setActiveOnly(boolean activeOnly) { | ||
| request.activeOnly(activeOnly); | ||
| return this; | ||
| } | ||
|
|
||
| } | ||
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.
We should not be including any further links to elasticsearch documentation anymore. This should be redirected to opensearch documentation and if not present, can open an issue in opensearch-project/documentation-website to create the same.
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 @Poojita-Raj for catching this, yes you are right. I have temporarily added url of opensearch documentation for cat recovery API, I will update this once I open an issue with opensearch-project/documentation-website