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.

Sign up for GitHub

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

Jump to bottom

Update remote store stats api documentation #5107

Merged
merged 5 commits into from
Sep 28, 2023
Merged

Update remote store stats api documentation #5107

merged 5 commits into from
Sep 28, 2023

Conversation

ashking94
Copy link
Member

This closes #4904

Description

#4904
Describe what this change achieves.

Issues Resolved

#4904
List any issues this PR will resolve, e.g. Closes [...].

Checklist

  • 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.

cwillum
cwillum approved these changes Sep 26, 2023
View reviewed changes
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
@Naarcha-AWS @cwillum
Apply suggestions from code review
fce31ad 
Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
ashking94
ashking94 commented Sep 28, 2023
View reviewed changes
Copy link
Member Author

@ashking94 ashking94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Nate, this looks good. Let's get this merged.

natebower
natebower reviewed Sep 28, 2023
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated
Use the Remote Store Stats API to monitor shard-level remote store performance.
Use the Remote Store Stats API to monitor shard-level remote-backed storage performance.

Metrics returned from this API only relate to indexes stored on remote-backed nodes. For an aggregated output on an index in a node or cluster level, use the [Index Stats]({{site.url}}{{site.baseurl}}/api-reference/index-apis/stats/), [Nodes Stats]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/nodes-stats/) or [Cluster Stats]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/cluster-stats/) API.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second sentence: Should "level" be deleted, or should this read "on an index at the node or cluster level"?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second one. Adjusting.

_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md Outdated Show resolved Hide resolved
@Naarcha-AWS @natebower
Apply suggestions from code review
b337f31 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added the backport 2.10 PR: Backport label for 2.10 label Sep 28, 2023
@Naarcha-AWS Naarcha-AWS merged commit 9242b88 into opensearch-project:main Sep 28, 2023
4 checks passed
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Sep 28, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 28, 2023
@github-actions @Naarcha-AWS
@cwillum @natebower
Update remote store stats api documentation (#5107)
5281d3c 
* Update remote store stats api documentation

This closes #4904

Signed-off-by: Ashish <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update remote-store-stats-api.md

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Ashish <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 9242b88)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS added a commit that referenced this pull request Sep 28, 2023
@opensearch-trigger-bot @github-actions
@Naarcha-AWS @cwillum @natebower
Update remote store stats api documentation (#5107) (#5116)
bd34720 
* Update remote store stats api documentation

This closes #4904



* Apply suggestions from code review



* Update remote-store-stats-api.md

* Apply suggestions from code review




* Apply suggestions from code review




---------






(cherry picked from commit 9242b88)

Signed-off-by: Ashish <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
vagimeli pushed a commit that referenced this pull request Oct 13, 2023
@ashking94 @Naarcha-AWS
@cwillum @natebower @vagimeli
Update remote store stats api documentation (#5107)
231acf0 
* Update remote store stats api documentation

This closes #4904

Signed-off-by: Ashish <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update remote-store-stats-api.md

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Ashish <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
@ashking94 @Naarcha-AWS
@cwillum @natebower @harshavamsi
Update remote store stats api documentation (opensearch-project#5107)
8873cb0 
* Update remote store stats api documentation 

This closes opensearch-project#4904

Signed-off-by: Ashish <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update remote-store-stats-api.md

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Ashish <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
@ashking94 @Naarcha-AWS
@cwillum @natebower @vagimeli
Update remote store stats api documentation (#5107)
c2dabb7 
* Update remote store stats api documentation 

This closes #4904

Signed-off-by: Ashish <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update remote-store-stats-api.md

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Ashish <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natebower natebower natebower left review comments

@Naarcha-AWS Naarcha-AWS Naarcha-AWS left review comments

@cwillum cwillum cwillum approved these changes

@hdhalter hdhalter Awaiting requested review from hdhalter

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@ananzh ananzh Awaiting requested review from ananzh

@seanneumann seanneumann Awaiting requested review from seanneumann

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

Assignees
No one assigned
Labels
backport 2.10 PR: Backport label for 2.10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Update remote store stats api documentation with latest segments and translog fields
4 participants
@ashking94 @Naarcha-AWS @natebower @cwillum