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] Add documentation for URI path filterning support for cluster/stats API. #8527

Open
1 of 4 tasks
SwethaGuptha opened this issue Oct 14, 2024 · 0 comments
Open
1 of 4 tasks
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.18.0

Comments

@SwethaGuptha
Copy link

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.
With opensearch-project/OpenSearch#15938, the cluster/stats API will have filtering support that will allow the clients to fetch only specific metrics from cluster/stats instead of all metrics. This is similar to current support provided in _nodes/stats API. As mentioned in the original issue, the API will support two new URI paths:

/_cluster/stats/{metric}/nodes/{nodeId}
/_cluster/stats/{metric}/{index_metric}/nodes/{nodeId}

Valid Metrics:

os, process, jvm, fs, plugins, ingest, network_types, discovery_types, packaging_types, indices, _all

Valid Index Metrics:

shards, docs, store , field_data, query_cache, completion, segments, analysis, mappings, _all

*Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.18.0
Projects
None yet
Development

No branches or pull requests

2 participants