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 spec for cluster stats metric and index_metric filter paths. #639

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

SwethaGuptha
Copy link

Description

Adding specs for path /_cluster/stats/{metric}/nodes/{nodeId} and /_cluster/stats/{metric}/{index_metric}/nodes/{nodeId} in cluster/stats API. 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.

Issues Resolved

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

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Contributor

github-actions bot commented Oct 24, 2024

Changes Analysis

Commit SHA: 590f18d
Comparing To SHA: abc7163

API Changes

Summary

├─┬Paths
│ ├──[➕] path (1862:3)
│ └──[➕] path (1840:3)
└─┬Components
  ├──[➕] parameters (17050:7)
  ├──[➕] parameters (17060:7)
  ├──[➕] schemas (46716:7)
  └──[➕] schemas (46687:7)

Document Element Total Changes Breaking Changes
paths 2 0
components 4 0
  • Total Changes: 6
  • Additions: 6

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11502375639/artifacts/2099725524

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 30 32 2

@SwethaGuptha SwethaGuptha force-pushed the api_spec_cluster_stats_metric_filtering branch 3 times, most recently from 4c500a7 to d0602a5 Compare October 24, 2024 07:40
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Looking good.

  1. Bump the SHA for a more recent build of 2.18 and 3.0 in https://github.com/opensearch-project/opensearch-api-specification/blob/main/.github/workflows/test-spec.yml#L45 until tests pass.
  2. Add to CHANGELOG.

Signed-off-by: Swetha Guptha <gupthasg@amazon.com>
@dblock
Copy link
Member

dblock commented Oct 24, 2024

@SwethaGuptha Looks like the build has other problems (missing other plugins like SQL and ISM). This is a known and rather annoying problem, 3.x builds don't always have everything. You should chase what's broken in OpenSearch main distribution.

I opened opensearch-project/opensearch-build#5130 to see what the infra team says about this (cc: @gaiksaya).

@gaiksaya

@SwethaGuptha
Copy link
Author

@SwethaGuptha Looks like the build has other problems (missing other plugins like SQL and ISM). This is a known and rather annoying problem, 3.x builds don't always have everything. You should chase what's broken in OpenSearch main distribution.

I opened opensearch-project/opensearch-build#5130 to see what the infra team says about this (cc: @gaiksaya).

@gaiksaya

Thanks @dblock for creating the issue. Did the tests work for v#3.0.0 previously? I see there are some failures from core OS as well. Also,I see the latest image available for v#3.0 is from eight days ago, do you know what cadence is followed for updating the version image?

@dblock
Copy link
Member

dblock commented Oct 24, 2024

Thanks @dblock for creating the issue. Did the tests work for v#3.0.0 previously? I see there are some failures from core OS as well.

Yes, the failure on main right now came from #625 and will get fixed soon.

Also,I see the latest image available for v#3.0 is from eight days ago, do you know what cadence is followed for updating the version image?

I think they try to build one daily, but it doesn't always work :(

@gaiksaya
Copy link
Member

I opened opensearch-project/opensearch-build#5130 to see what the infra team says about this (cc: @gaiksaya).

@gaiksaya

Will add more details to the issue but docker image is build using tarball. And all the distributions contains distribution manifest with all the information about a distribution and the components bundled in that distribution.

@dblock
Copy link
Member

dblock commented Oct 24, 2024

I opened opensearch-project/opensearch-build#5130 to see what the infra team says about this (cc: @gaiksaya).
@gaiksaya

Will add more details to the issue but docker image is build using tarball. And all the distributions contains distribution manifest with all the information about a distribution and the components bundled in that distribution.

It's just hard to tell from a distribution what the docker SHA is.

@SwethaGuptha
Copy link
Author

@dblock Any inputs on the next steps to make progress on this PR?

@dblock
Copy link
Member

dblock commented Oct 29, 2024

@SwethaGuptha yes, update the SHAs to the latest available for 2.18 and 3.0 and see if all tests pass - it has to pass 2.18, but you can mark tests as < 3.0 if that one doesn't pass, for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants