Skip to content

Conversation

@stefnestor
Copy link
Contributor

👋 howdy, team!

Can we add these common JQ queries to the ILM Troubleshooting Doc which check for indices not in "waiting" steps (as defined by me) of [complete, check-rollover-ready] and claiming the rest are "transient" steps.

Will still be helpful even after #93859 .

👋 howdy, team!

Can we add these common JQ queries to the [ILM Troubleshooting Doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-error-handling.html) which check for indices not in "waiting" steps (as defined by Stef) of `[complete, check-rollover-ready]` and defining them as expectedly "transient" steps.

Is helpful until/unless #93859
@stefnestor stefnestor added >enhancement >docs General docs changes :Data Management/ILM+SLM Index and Snapshot lifecycle management Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels Sep 16, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

@stefnestor please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine added the external-contributor Pull request authored by a developer outside the Elasticsearch team label Sep 16, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

The trouble with docs like this is that they aren't covered by tests so will fall out of date in time without anybody noticing. If these things are useful, let's include them in the ILM explain output directly.

Co-authored-by: David Turner <david.turner@elastic.co>
@mattc58 mattc58 added v8.12.0 and removed v8.11.0 labels Oct 4, 2023
@stefnestor
Copy link
Contributor Author

@DaveCTurner does this look good to merge? (Noted on pushing this type of data into ILM overview / ES internal health longer-term.)

@DaveCTurner
Copy link
Contributor

No - these commands need test coverage to avoid them going stale over time. I think the easiest way to achieve that will be to add these things to the ILM explain API, but maybe there are other ways if we really want to have jq commands in the docs.

@dakrone
Copy link
Member

dakrone commented Apr 18, 2024

I think we can close this, since we discussed it and decided adding columns to the cat indices would be a better solution.

@dakrone dakrone closed this Apr 18, 2024
@stefnestor
Copy link
Contributor Author

👋 @dakrone @DaveCTurner I would still prefer an aggregated summary on how ILM indices are doing if possible. Maybe my team's just used to the JQ query if we'd reconsider it.

Alternatively, It looks like some ES Diags on more recent versions also have an ilm section under internal_health.json from this code but that's publicly undocumented AFAICT to share with users.

@dakrone
Copy link
Member

dakrone commented Jun 17, 2024

That is the ILM indicator of the health report API, which is documented at https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html#health-api-response-details-ilm

@stefnestor stefnestor deleted the stefnestor-patch-3 branch July 24, 2024 22:52
@stefnestor
Copy link
Contributor Author

stefnestor commented Oct 21, 2025

As follow-up to ongoing troubleshooting pain points of not documenting this JQ command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Data Management/ILM+SLM Index and Snapshot lifecycle management >docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v8.15.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants