Skip to content

Add description to _cluster/stats ccs section #4311

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

Merged
merged 3 commits into from
Apr 28, 2025
Merged

Conversation

smalyshev
Copy link
Contributor

Document ccs section in _cluster/stats response.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cluster.stats 🔴 27/27 0/27

You can validate these APIs yourself by using the make validate target.

@smalyshev smalyshev requested a review from Copilot April 25, 2025 22:06
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR documents the cross-cluster search (CCS) section in the _cluster/stats response. The key changes include:

  • Adding detailed documentation and new type classes/interfaces for cross-cluster stats (CCSStats, RemoteClusterInfo, CCSUsageStats, etc.) in the TypeScript definitions.
  • Updating the StatsResponseBase in ClusterStatsResponse.ts to include the new ccs property.
  • Propagating similar changes to the generated output types in output/typescript/types.ts.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

File Description
specification/cluster/stats/types.ts Added new CCS types and documentation for cross-cluster stats.
specification/cluster/stats/ClusterStatsResponse.ts Updated StatsResponseBase to include the ccs field.
output/typescript/types.ts Added corresponding interfaces for CCS stats and remote cluster info.
Files not reviewed (1)
  • output/openapi/elasticsearch-openapi.json: Language not supported

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cluster.stats 🔴 27/27 0/27

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cluster.stats 🔴 27/27 0/27

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

@quux00 quux00 left a comment

Choose a reason for hiding this comment

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

LGTM

@smalyshev smalyshev merged commit c9801b1 into main Apr 28, 2025
8 checks passed
@smalyshev smalyshev deleted the add-ccs-stats-docs branch April 28, 2025 21:08
Copy link
Contributor

The backport to 8.x failed:

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

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-8.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-4311-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c9801b1b2d51276dd24f9254aa7c463ab6406939
# Push it to GitHub
git push --set-upstream origin backport-4311-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.x

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-4311-to-8.x.

Copy link
Contributor

The backport to 8.18 failed:

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

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-8.18 8.18
# Navigate to the new working tree
cd .worktrees/backport-8.18
# Create a new branch
git switch --create backport-4311-to-8.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c9801b1b2d51276dd24f9254aa7c463ab6406939
# Push it to GitHub
git push --set-upstream origin backport-4311-to-8.18
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.18

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

github-actions bot pushed a commit that referenced this pull request Apr 28, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
smalyshev added a commit that referenced this pull request Apr 28, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)

Co-authored-by: Stanislav Malyshev <smalyshev@users.noreply.github.com>
smalyshev added a commit that referenced this pull request Apr 28, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
smalyshev added a commit that referenced this pull request Apr 28, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
smalyshev added a commit that referenced this pull request Apr 28, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
smalyshev added a commit that referenced this pull request Apr 28, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
smalyshev added a commit that referenced this pull request Apr 29, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
smalyshev added a commit that referenced this pull request Apr 29, 2025
* Add description to _cluster/stats ccs section

(cherry picked from commit c9801b1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants