Opt-in closed/hidden segments in /_cat/segments
#136168
Open
+117
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukewhiting
added
>enhancement
:Data Management/CAT APIs
elasticsearchmachine
added
the
Team:Data Management
|
Pinging @elastic/es-data-management (Team:Data Management) |
|
Hi @lukewhiting, I've created a changelog YAML for you. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds wildcard expansion capabilities to the /_cat/segments API to allow targeting closed and hidden indices, bringing it in line with other cat APIs. The main change introduces an allow_closed parameter that prevents exceptions when targeting closed indices while maintaining backward compatibility.
- Added
expand_wildcardsandallow_closedparameters to the segments cat API - Updated the API to use
IndicesOptionsfor proper wildcard expansion handling - Added comprehensive test coverage for the new functionality
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| RestSegmentsAction.java | Core implementation adding IndicesOptions support and allow_closed capability |
| cat.segments.json | REST API specification updates for new parameters |
| 10_basic.yml | Test coverage for wildcard expansion with closed and hidden indices |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json
Outdated
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java
Outdated
Show resolved
Hide resolved
lukewhiting
force-pushed
the
es-5583-shards-cat-additional-options
branch
from
8715767 to
2d3f75a
Compare
szybia
reviewed
Oct 8, 2025
rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json
Outdated
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java
Outdated
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java
Show resolved
Hide resolved
rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/cat.segments/10_basic.yml
Show resolved
Hide resolved
Co-authored-by: Szymon Bialkowski <[email protected]>
…s.json Co-authored-by: Szymon Bialkowski <[email protected]>
szybia
changed the title
/_cat/segments
…kewhiting/elasticsearch into es-5583-shards-cat-additional-options
szybia
reviewed
Oct 9, 2025
szybia
approved these changes
Oct 9, 2025
szybia
reviewed
Oct 9, 2025
lukewhiting
added
the
auto-backport
…kewhiting/elasticsearch into es-5583-shards-cat-additional-options
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the wildcard expansion options available in other cat API's to allow targeting closed and hidden indices.
It also includes a new flag
allow_closedthat prevents an exception being thrown if targeting a closed index as is the current behaviour. This seemed like the cleanest way to add the new function without breaking BWC.Fixes ES-5583
Fixes #97023