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

Adds documentation for tiered caching stats API #7158

Merged
merged 9 commits into from
May 17, 2024

Conversation

peteralfonsi
Copy link
Contributor

Description

Adds documentation for the cache stats API, which was introduced as part of tiered caching. Follows up to cache plugin documentation PR.

Issues Resolved

Followup on #6300.

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.

@peteralfonsi
Copy link
Contributor Author

@hdhalter This adds documentation around pieces of the tiered caching feature which were merged in separately from the things covered in Sagar's main doc PR. Would you be able to take a look?

@hdhalter hdhalter added backport 2.14 PR: Backport label for 2.14 4 - Doc review PR: Doc review in progress labels May 15, 2024
@hdhalter
Copy link
Contributor

@hdhalter This adds documentation around pieces of the tiered caching feature which were merged in separately from the things covered in Sagar's main doc PR. Would you be able to take a look?

Will do, @peteralfonsi, but can you please address the style errors? Thanks.

Signed-off-by: Peter Alfonsi <[email protected]>
@Naarcha-AWS Naarcha-AWS self-assigned this May 15, 2024
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
peteralfonsi and others added 3 commits May 15, 2024 15:10
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
Co-authored-by: Peter Alfonsi <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Peter Alfonsi <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels May 16, 2024
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.

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

_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 4 commits May 16, 2024 15:19
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit 88d1900 into opensearch-project:main May 17, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 17, 2024
* Adds docs for tiered caching stats API

Signed-off-by: Peter Alfonsi <[email protected]>

* Fixed style errors

Signed-off-by: Peter Alfonsi <[email protected]>

* Apply suggestions from code review

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>

* Update _api-reference/nodes-apis/nodes-stats.md

Co-authored-by: Peter Alfonsi <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _api-reference/nodes-apis/nodes-stats.md

Co-authored-by: Peter Alfonsi <[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]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>

* Changed wording

Signed-off-by: Peter Alfonsi <[email protected]>

---------

Signed-off-by: Peter Alfonsi <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Peter Alfonsi <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 88d1900)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress backport 2.14 PR: Backport label for 2.14
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants