(Doc+) Expand watermark resolution #119174
Open
+25
−10
Conversation
This file contains 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
Relaunch #116892 since the original one seems to be outdated and hard to update branch.
kunisen
added
>enhancement
>docs
|
Documentation preview: |
|
@kunisen please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation. |
|
Pinging @elastic/es-docs (Team:Docs) |
| @@ -53,7 +53,7 @@ GET _cluster/allocation/explain | |||
| [[fix-watermark-errors-temporary]] | |||
| ==== Temporary Relief | |||
|
|
|||
| To immediately restore write operations, you can temporarily increase the | |||
| To immediately restore write operations, you may consider temporarily increasing the | |||
There was a problem hiding this comment.
let's revert this - the original version was closer to our style
Suggested change
| To immediately restore write operations, you may consider temporarily increasing the | |
| To immediately restore write operations, you can temporarily increase |
Comment on lines
+105
to
106
| To resolve, we recommend you do one of the following best suited | ||
| to your use case: |
There was a problem hiding this comment.
Suggested change
| To resolve, we recommend you do one of the following best suited | |
| to your use case: | |
| To resolve watermark errors permanently, perform one of the following actions: |
| * add nodes to the affected <<data-tiers,data tiers>> | ||
| + | ||
| TIP: You should enable <<xpack-autoscaling,autoscaling>> for clusters deployed using our {ess}, {ece}, and {eck} platforms. | ||
| * horizontally scale nodes of the affected <<data-tiers,data tiers>> |
There was a problem hiding this comment.
what does "horizontally" mean here?
Suggested change
| * horizontally scale nodes of the affected <<data-tiers,data tiers>> | |
| * Horizontally scale nodes of the affected <<data-tiers,data tiers>>. |
| + | ||
| TIP: On {ess}, https://support.elastic.co[Elastic Support] intervention may | ||
| become necessary if <<cluster-health,cluster health>> reaches `status:red`. | ||
| * vertically scale existing nodes to increase disk space |
There was a problem hiding this comment.
ditto - what does 'vertically' imply?
Suggested change
| * vertically scale existing nodes to increase disk space | |
| * Vertically scale existing nodes to increase disk space. |
|
|
||
| * delete unneeded indices using the <<indices-delete-index,delete index API>> | ||
| * delete indices using the <<indices-delete-index,delete index API>>, either |
There was a problem hiding this comment.
Suggested change
| * delete indices using the <<indices-delete-index,delete index API>>, either | |
| * Delete indices using the <<indices-delete-index,delete index API>>, either |
Comment on lines
+113
to
+114
| permanently if unneeded or temporarily to later | ||
| <<snapshots-restore-snapshot,snapshot restore>> |
There was a problem hiding this comment.
Suggested change
| permanently if unneeded or temporarily to later | |
| <<snapshots-restore-snapshot,snapshot restore>> | |
| permanently if the index isn't needed, or temporarily to later | |
| <<snapshots-restore-snapshot,restore>>. |
Comment on lines
+119
to
+125
| TIP: On {ess} and {ece}, indices may need to be temporarily deleted via | ||
| its {cloud}/ec-api-console.html[Elasticsearch API Console] to later | ||
| <<snapshots-restore-snapshot,snapshot restore>> in order to resolve | ||
| <<cluster-health,cluster health>> `status:red` which will block | ||
| {cloud}/ec-activity-page.html[attempted changes]. If you experience issues | ||
| with this resolution flow on {ess}, kindly reach out to | ||
| https://support.elastic.co[Elastic Support] for assistance. |
There was a problem hiding this comment.
can we explain why they have to do the deletion here? how does someone determine if this note applies to them?
Comment on lines
+127
to
+128
| To avoid this situation, we recommend you do one of the following best | ||
| suited to your use case: |
There was a problem hiding this comment.
Suggested change
| To avoid this situation, we recommend you do one of the following best | |
| suited to your use case: | |
| == Prevent watermark errors | |
| To avoid watermark errors in future, , perform one of the following actions: |
Comment on lines
+130
to
+135
| * enable <<xpack-autoscaling,autoscaling>> for clusters deployed using our | ||
| {ess}, {ece}, and {eck} platforms | ||
|
|
||
| * setup {kibana-ref}/kibana-alerts.html[Stack Monitoring Alerts] on top of | ||
| <<monitor-elasticsearch-cluster,{es} Monitoring>> to be notified before | ||
| flood-stage watermark is reached |
There was a problem hiding this comment.
Suggested change
| * enable <<xpack-autoscaling,autoscaling>> for clusters deployed using our | |
| {ess}, {ece}, and {eck} platforms | |
| * setup {kibana-ref}/kibana-alerts.html[Stack Monitoring Alerts] on top of | |
| <<monitor-elasticsearch-cluster,{es} Monitoring>> to be notified before | |
| flood-stage watermark is reached | |
| * If you're using {ess}, {ece}, or {eck}: Enable <<xpack-autoscaling,autoscaling>>. | |
| * Set up {kibana-ref}/kibana-alerts.html[stack monitoring alerts] on top of | |
| <<monitor-elasticsearch-cluster,{es} monitoring>> to be notified before | |
| the flood-stage watermark is reached. |
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.
gradle check? Not a code PRDescription
Relaunch #116892 since the original one seems to be outdated and hard to update branch. It's copying 10fb2b1 without any further contents update.
Thanks @stefnestor for reaching out and sync. As we chatted, since #116892 is outdated and seems hard to update branch (to merge current main branch to the PR), I copied the contents out from original one manually and created this one. Let's keep your style this time (on ES doc).
For the cloud side doc PR how to handle, let's discuss further offline. 🙏