-
Notifications
You must be signed in to change notification settings - Fork 195
Expand "Watermark errors" page #4521
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
base: main
Are you sure you want to change the base?
Conversation
My suggestiosn were: 1 - remove the uneecessary period before the comma. 2 - added a new section `Context` with clearer Explanation of Watermark Levels since the page assumes the reader already understands the difference between low, high, and flood-stage watermarks. 3 - Added `Common causes of watermark errors` with the most common Causes of Watermark Errors. This would help users prevent the issue in the first place. 4 - Added `Preventing watermark errors` section with suggestions like setting up disk usage monitoring alerts, optimizing shard sizes, or using ILM proactively could be added.
Vale Linting ResultsSummary: 2 suggestions found 💡 Suggestions (2)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
🔍 Preview links for changed docs |
yetanothertw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for these improvements, they look really good! 🪴
I've left a few comments, mostly all around links syntax. Let me know if you need any help with that.
| ::: | ||
|
|
||
|
|
||
| ## Context |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can be a bit more specific with the subheading. Context is too generic. Perhaps something like:
| ## Context | |
| ## Disk-based shard allocation watermarks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rodrigomadalozzo "context" already exists implicitly in the first couple intro paragraphs. Perhaps we should consider merging/supplementing this content into that to avoid the duplication.
Co-authored-by: Vlada Chirmicci <[email protected]>
| * update related [ILM policy](../../manage-data/lifecycle/index-lifecycle-management.md) to push indices through to later [data tiers](../../manage-data/lifecycle/data-tiers.md) | ||
|
|
||
|
|
||
| ## Preventing watermark errors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rodrigomadalozzo if you feel up for it, we might be able to do two KBs in one go. Supplementing the one you're doing, you could consider (not giving dive-in detail just referencing) the dangers of bad disk watermarks by adding a bullet point like
* {{es}} recommends using default watermark settings. Experts can override [the watermark thresholds and headroom](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md) but risk not giving enough disk for background processes such as force merge, not being right-sized to data ingestion rates vs ILM settings, and possibly `disk is full` errors if 100% disk is reached.
As a support engineer, I have the following suggestions based on my experience handling cases related to disk space and watermark issues - https://www.elastic.co/docs/troubleshoot/elasticsearch/fix-watermark-errors:
cc @stefnestor
Generative AI disclosure