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

Improve human-readability of ILM timing error message #70336

Closed
cjcenizal opened this issue Mar 11, 2021 · 5 comments · Fixed by #75099
Closed

Improve human-readability of ILM timing error message #70336

cjcenizal opened this issue Mar 11, 2021 · 5 comments · Fixed by #75099
Labels
:Data Management/ILM+SLM Index and Snapshot lifecycle management >enhancement good first issue low hanging fruit Team:Data Management Meta label for data/management team Team:Deployment Management Meta label for Management Experience - Deployment Management team

Comments

@cjcenizal
Copy link
Contributor

cjcenizal commented Mar 11, 2021

In #70089 we added guardrails to protect against ILM policies being created with phase timings that would result in phases running out of order.

For example, let's say the user tries to save a policy configured with a the warm phase that runs 3 days after rollover, a cold phase that runs 2 days after rollover, and a delete phase that runs 1 day after rollover. The API would reject this policy with this error:

phases [cold,delete] configure a [min_age] value less than the [min_age] of [3d] for the [warm] phase, configuration: {cold=2d, delete=1d}

The UI team hasn't budgeted time to replicate this error-checking logic in the UI, so for the time being we'll surface the API error directly to the user. Can we make it more human-readable? For example:

Your policy is configured to run the cold phase (min_age: 2 days) and the delete phase (min_age: 1 day) before the warm phase (min_age: 3 days). Change the phase timing so that the phases will execute in the order of hot, warm, then cold.

CC @dakrone @debadair @jloleysens

@cjcenizal cjcenizal added >enhancement :Data Management/ILM+SLM Index and Snapshot lifecycle management Team:Data Management Meta label for data/management team Team:Deployment Management Meta label for Management Experience - Deployment Management team labels Mar 11, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-ui (Team:UI)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

@cjcenizal
Copy link
Contributor Author

For reference, here are some guidelines that @gchaps and other writers have prepared for errors in the UI.

image

@cjcenizal
Copy link
Contributor Author

CC @jethr0null @jakelandis

@Esduard
Copy link
Contributor

Esduard commented Jul 8, 2021

@cjcenizal I made a new message error that is almost identical to your request. I also had some fun trying to find a way to make the proper text depending on the number of phases.

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 >enhancement good first issue low hanging fruit Team:Data Management Meta label for data/management team Team:Deployment Management Meta label for Management Experience - Deployment Management team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants