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

Fix incorrect documentation about query cache stats #9021

Merged

Conversation

peteralfonsi
Copy link
Contributor

Description

Some of the descriptions for the query cache stats values returned in the nodes stats API are incorrect. This PR fixes them.

Issues Resolved

N/A, did not open an issue for this minor fix

Version

All versions that reference the query cache stats, which I believe is 1.3 onwards

Frontend features

N/A

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.

Copy link

github-actions bot commented Jan 6, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @peteralfonsi! One suggestion.

_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
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.

LGTM

@kolchfa-aws kolchfa-aws added the backport 2.18 PR: Backport label for 2.18 label Jan 9, 2025
@kolchfa-aws kolchfa-aws merged commit 5f6a38c into opensearch-project:main Jan 9, 2025
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 9, 2025
* Fix incorrect documentation about query cache stats

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

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

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>

---------

Signed-off-by: Peter Alfonsi <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
Co-authored-by: Peter Alfonsi <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit 5f6a38c)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.18 failed:

Server Error

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.18 2.18
# Navigate to the new working tree
pushd ../.worktrees/backport-2.18
# Create a new branch
git switch --create backport/backport-9021-to-2.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5f6a38cddba13ef7bec0b99e0b17f62449518275
# Push it to GitHub
git push --set-upstream origin backport/backport-9021-to-2.18
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.18

Then, create a pull request where the base branch is 2.18 and the compare/head branch is backport/backport-9021-to-2.18.

@kolchfa-aws kolchfa-aws added backport 2.18 PR: Backport label for 2.18 and removed backport 2.18 PR: Backport label for 2.18 labels Jan 9, 2025
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.18 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.18 2.18
# Navigate to the new working tree
pushd ../.worktrees/backport-2.18
# Create a new branch
git switch --create backport/backport-9021-to-2.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5f6a38cddba13ef7bec0b99e0b17f62449518275
# Push it to GitHub
git push --set-upstream origin backport/backport-9021-to-2.18
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.18

Then, create a pull request where the base branch is 2.18 and the compare/head branch is backport/backport-9021-to-2.18.

@kolchfa-aws kolchfa-aws added backport 2.18 PR: Backport label for 2.18 and removed backport 2.18 PR: Backport label for 2.18 labels Jan 9, 2025
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.18 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.18 2.18
# Navigate to the new working tree
pushd ../.worktrees/backport-2.18
# Create a new branch
git switch --create backport/backport-9021-to-2.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5f6a38cddba13ef7bec0b99e0b17f62449518275
# Push it to GitHub
git push --set-upstream origin backport/backport-9021-to-2.18
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.18

Then, create a pull request where the base branch is 2.18 and the compare/head branch is backport/backport-9021-to-2.18.

russcam pushed a commit to russcam/documentation-website that referenced this pull request Jan 10, 2025
…ct#9021)

* Fix incorrect documentation about query cache stats

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

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

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>

---------

Signed-off-by: Peter Alfonsi <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
Co-authored-by: Peter Alfonsi <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
russcam pushed a commit to russcam/documentation-website that referenced this pull request Jan 12, 2025
…ct#9021)

* Fix incorrect documentation about query cache stats

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

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

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>

---------

Signed-off-by: Peter Alfonsi <[email protected]>
Signed-off-by: Peter Alfonsi <[email protected]>
Co-authored-by: Peter Alfonsi <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Russ Cam <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.18 PR: Backport label for 2.18
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants