Add CAT segment replication API #2937

kolchfa-aws · 2023-02-16T19:31:11Z

Fixes #2627

Checklist

[ x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <[email protected]>

_api-reference/cat/cat-segment-replication.md

Co-authored-by: Melissa Vagi <[email protected]>

Naarcha-AWS

LGTM, but left a suggestion about the intro.

Naarcha-AWS · 2023-04-19T21:55:09Z

_api-reference/cat/cat-repositories.md

@@ -3,7 +3,7 @@ layout: default
 title: CAT repositories
 parent: CAT API



Small nit, should we remove this blank line?

Naarcha-AWS · 2023-04-19T22:05:05Z

_api-reference/cat/cat-segment-replication.md

+Introduced 2.7
+{: .label .label-purple }
+
+The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard. This API returns metrics on a shard level. The metrics provide information about how far behind the replicas are lagging with respect to the primary shard. 


Another small nit, I'm confused by "This API returns metrics on a shard level".
Will the API always return metrics on a shard level on top of the information about active and completed events on shards? Can you opt out of seeing metrics in the response (based on the examples, it will return the time comparison between the primary shard, and optionally return additional metrics)?

I would consider turning the description into a compound sentence:

Suggested change

The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard. This API returns metrics on a shard level. The metrics provide information about how far behind the replicas are lagging with respect to the primary shard.

The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard and related metrics on a shard level. These metrics provide information about how far behind the replicas are lagging with respect to the primary shard.

Signed-off-by: Fanit Kolchina <[email protected]>

…ch-project/documentation-website into Fix2627-cat-segment-api

natebower

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/cat/cat-segment-replication.md

natebower · 2023-04-20T12:10:09Z

_api-reference/cat/cat-segment-replication.md

+Introduced 2.7
+{: .label .label-purple }
+
+The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the replicas are lagging with respect to the primary shard. 


Last sentence: "These metrics provide information about how far behind the primary shard the replicas are lagging"? As written, this may be initially read as though something is lagging behind the replicas.

Co-authored-by: Nathan Bower <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

* Add CAT segment replication API Signed-off-by: Fanit Kolchina <[email protected]> * Refactoring after a conversation with SMEs Signed-off-by: Fanit Kolchina <[email protected]> * Added copy buttons and changed sample to example Signed-off-by: Fanit Kolchina <[email protected]> * Revise for 2.7 Signed-off-by: Fanit Kolchina <[email protected]> * Added aliases Signed-off-by: Fanit Kolchina <[email protected]> * Reorder pages Signed-off-by: Fanit Kolchina <[email protected]> * Update cat-segment-replication.md * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> * Implemented doc review comments Signed-off-by: Fanit Kolchina <[email protected]> * Update cat-segment-replication.md * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> * Implemented editorial review comment Signed-off-by: Fanit Kolchina <[email protected]> * Fix link Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

This reverts commit 80460f0.

* Add CAT segment replication API Signed-off-by: Fanit Kolchina <[email protected]> * Refactoring after a conversation with SMEs Signed-off-by: Fanit Kolchina <[email protected]> * Added copy buttons and changed sample to example Signed-off-by: Fanit Kolchina <[email protected]> * Revise for 2.7 Signed-off-by: Fanit Kolchina <[email protected]> * Added aliases Signed-off-by: Fanit Kolchina <[email protected]> * Reorder pages Signed-off-by: Fanit Kolchina <[email protected]> * Update cat-segment-replication.md * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> * Implemented doc review comments Signed-off-by: Fanit Kolchina <[email protected]> * Update cat-segment-replication.md * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> * Implemented editorial review comment Signed-off-by: Fanit Kolchina <[email protected]> * Fix link Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Add CAT segment replication API

d4a2f36

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws added the v2.6.0 label Feb 16, 2023

kolchfa-aws self-assigned this Feb 16, 2023

kolchfa-aws added 2 commits February 17, 2023 16:23

Refactoring after a conversation with SMEs

a72f37e

Signed-off-by: Fanit Kolchina <[email protected]>

Added copy buttons and changed sample to example

3b81f81

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws added 1 - Backlog Issue: The issue is unassigned or assigned but not started v-TBD and removed v2.6.0 labels Feb 21, 2023

Naarcha-AWS added v2.7.0 2 - In progress Issue/PR: The issue or PR is in progress. and removed v-TBD 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Mar 22, 2023

Naarcha-AWS added this to the v2.7 milestone Mar 22, 2023

Naarcha-AWS removed the 2 - In progress Issue/PR: The issue or PR is in progress. label Mar 22, 2023

Naarcha-AWS removed this from the v2.7 milestone Mar 22, 2023

Rishikesh1159 mentioned this pull request Apr 6, 2023

[DOC] Add new _cat/segment_replication API documentation #2627

Closed

4 tasks

kolchfa-aws added 4 commits April 18, 2023 19:12

Revise for 2.7

8146072

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'main' into Fix2627-cat-segment-api

2346f9e

Added aliases

fc5c174

Signed-off-by: Fanit Kolchina <[email protected]>

Reorder pages

0b2c02d

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws marked this pull request as ready for review April 19, 2023 17:25

Rishikesh1159 approved these changes Apr 19, 2023

View reviewed changes

Update cat-segment-replication.md

29fefff

vagimeli approved these changes Apr 19, 2023

View reviewed changes

_api-reference/cat/cat-segment-replication.md Outdated Show resolved Hide resolved

_api-reference/cat/cat-segment-replication.md Show resolved Hide resolved

Apply suggestions from code review

127007c

Co-authored-by: Melissa Vagi <[email protected]>

Naarcha-AWS approved these changes Apr 19, 2023

View reviewed changes

kolchfa-aws and others added 3 commits April 19, 2023 18:19

Implemented doc review comments

d622659

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'Fix2627-cat-segment-api' of https://github.com/opensear…

3dd12e1

…ch-project/documentation-website into Fix2627-cat-segment-api

Update cat-segment-replication.md

5d12826

natebower reviewed Apr 20, 2023

View reviewed changes

kolchfa-aws and others added 3 commits April 20, 2023 08:44

Apply suggestions from code review

c62d527

Co-authored-by: Nathan Bower <[email protected]>

Implemented editorial review comment

b606a15

Signed-off-by: Fanit Kolchina <[email protected]>

Fix link

ac28a03

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge release-notes PR: Include this PR in the automated release notes labels Apr 24, 2023

kolchfa-aws merged commit 9913d1d into main May 2, 2023

vagimeli added a commit that referenced this pull request May 4, 2023

Revert "Add CAT segment replication API (#2937)"

28bc9de

This reverts commit 80460f0.

Naarcha-AWS deleted the Fix2627-cat-segment-api branch March 28, 2024 23:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CAT segment replication API #2937

Add CAT segment replication API #2937

kolchfa-aws commented Feb 16, 2023

Naarcha-AWS left a comment

Naarcha-AWS Apr 19, 2023 •

edited

Loading

Naarcha-AWS Apr 19, 2023

natebower left a comment

natebower Apr 20, 2023

		@@ -3,7 +3,7 @@ layout: default
		title: CAT repositories
		parent: CAT API

	The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard. This API returns metrics on a shard level. The metrics provide information about how far behind the replicas are lagging with respect to the primary shard.
	The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard and related metrics on a shard level. These metrics provide information about how far behind the replicas are lagging with respect to the primary shard.

Add CAT segment replication API #2937

Add CAT segment replication API #2937

Conversation

kolchfa-aws commented Feb 16, 2023

Checklist

Naarcha-AWS left a comment

Choose a reason for hiding this comment

Naarcha-AWS Apr 19, 2023 • edited Loading

Choose a reason for hiding this comment

Naarcha-AWS Apr 19, 2023

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower Apr 20, 2023

Choose a reason for hiding this comment

Naarcha-AWS Apr 19, 2023 •

edited

Loading