Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]Modify stats api documentation to reflect addition of segment replication statistics #4954

Closed
1 of 4 tasks
Poojita-Raj opened this issue Sep 2, 2023 · 1 comment · Fixed by #4995
Closed
1 of 4 tasks
Assignees
Labels
3 - Done Issue is done/complete backport 2.9 PR: Backport label for 2.9 v2.10.0
Milestone

Comments

@Poojita-Raj
Copy link
Contributor

Poojita-Raj commented Sep 2, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

Changes requested:

  1. Under list of index properties in this table (holding list of properties for index statistics for each shard), we need to add the following rows:
    Link: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-stats/#indices
Field Field type Description
segments.segment_replication Object Segment replication statistics for all primary shards with segment replication enabled that exist on the node.
segments.segment_replication.maxBytesBehind long The max number of bytes behind the primary a replica is.
segments.segment_replication.totalBytesBehind long The total number of bytes behind the primary the replicas are.
segments.segment_replication.maxReplicationLag long The max time (in milliseconds) taken by a replica to catch up to primary.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
PR: opensearch-project/OpenSearch#9709
Issue: opensearch-project/OpenSearch#9417

@Naarcha-AWS
Copy link
Collaborator

Moved this to Pr #4995

@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Sep 13, 2023
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 3 - Tech review PR: Tech review in progress labels Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment