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

Add URI paths for cluster stats filtering. #8595

Merged

Conversation

SwethaGuptha
Copy link
Contributor

@SwethaGuptha SwethaGuptha commented Oct 22, 2024

Description

Documentation change for new cluster stats URI path for filtering requested metrics.

Issues Resolved

Closes #8527

Version

_List the OpenSearch version to which this PR applies, e.g. 2.18

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

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

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.

@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress v2.18.0 labels Oct 22, 2024
@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes and removed 4 - Doc review PR: Doc review in progress labels Oct 22, 2024
@Naarcha-AWS Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label Oct 22, 2024
@SwethaGuptha
Copy link
Contributor Author

@Naarcha-AWS Can you please let me know what would be the next steps for this PR or any action is pending on me?

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

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

Made my edits on top. Will pass this to editorial review.

@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Oct 28, 2024
@Naarcha-AWS
Copy link
Collaborator

@Naarcha-AWS Can you please let me know what would be the next steps for this PR or any action is pending on me?

@SwethaGuptha: No other action is required on your part at this time! There's a chance we might have a couple of follow up questions about the PR, but we'll ping you directly on a comment if that's the case.

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 @SwethaGuptha Please see my comments and changes and tag me for approval when addressed. Thanks!

_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
`nodes.count` | How many nodes were returned from the request.
`nodes.versions` | OpenSearch's version number.
`nodes.os` | Information about the operating systems used in the nodes.
`nodes.process` | The processes the returned nodes use.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"A list of the"? "Information about the"?

`nodes.process` | The processes the returned nodes use.
`nodes.jvm` | Statistics about the Java Virtual Machines in use.
`nodes.fs` | The nodes' file storage.
`nodes.plugins` | The OpenSearch plugins integrated within the nodes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"A list of the"? "Information about the"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

A list of the.

_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
@opensearch-project opensearch-project deleted a comment from natebower Oct 29, 2024
Naarcha-AWS and others added 6 commits October 29, 2024 06:55
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS
Copy link
Collaborator

@natebower: Implemented your review. Let me know if I missed anything.

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 LGTM with two noted changes. Thanks!

_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits October 29, 2024 07:09
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit cfaecad into opensearch-project:main Oct 29, 2024
5 checks passed
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 release-notes PR: Include this PR in the automated release notes v2.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation for URI path filterning support for cluster/stats API.
5 participants