From 098eee5d095b1724f9e635ca4e592fb6ac34e2d5 Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Thu, 13 Jul 2023 09:46:05 -0400
Subject: [PATCH] [8.9] [DOCv2] Temporarily disable Kibana Rules (#126869)
 (#161865)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCv2] Temporarily disable Kibana Rules
(#126869)](https://github.com/elastic/kibana/pull/126869)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Stef
Nestor","email":"26751266+stefnestor@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-07-13T13:22:55Z","message":"[DOCv2]
Temporarily disable Kibana Rules (#126869)\n\n👋🏼 @gchaps asked me to
file a new PR since my
last\r\nhttps://github.com/elastic/kibana/pull/122573 got too far
behind.\r\n\r\n## Summary\r\n\r\n🙏🏼 per #116017, adds insight on how to
temporarily disable Kibana Rules\r\nfor clusters which need breathing
room.\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>","sha":"b1d619617a0321617636c7c1bbcbf74e393a5d9e","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","auto-backport","Feature:Alerting/RulesManagement","v8.9.0","v8.10.0"],"number":126869,"url":"https://github.com/elastic/kibana/pull/126869","mergeCommit":{"message":"[DOCv2]
Temporarily disable Kibana Rules (#126869)\n\n👋🏼 @gchaps asked me to
file a new PR since my
last\r\nhttps://github.com/elastic/kibana/pull/122573 got too far
behind.\r\n\r\n## Summary\r\n\r\n🙏🏼 per #116017, adds insight on how to
temporarily disable Kibana Rules\r\nfor clusters which need breathing
room.\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>","sha":"b1d619617a0321617636c7c1bbcbf74e393a5d9e"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/126869","number":126869,"mergeCommit":{"message":"[DOCv2]
Temporarily disable Kibana Rules (#126869)\n\n👋🏼 @gchaps asked me to
file a new PR since my
last\r\nhttps://github.com/elastic/kibana/pull/122573 got too far
behind.\r\n\r\n## Summary\r\n\r\n🙏🏼 per #116017, adds insight on how to
temporarily disable Kibana Rules\r\nfor clusters which need breathing
room.\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>","sha":"b1d619617a0321617636c7c1bbcbf74e393a5d9e"}}]}]
BACKPORT-->

Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com>
---
 .../alerting-troubleshooting.asciidoc         | 21 ++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/docs/user/alerting/alerting-troubleshooting.asciidoc b/docs/user/alerting/alerting-troubleshooting.asciidoc
index 34a97b3eb59036..88b553c9064c1a 100644
--- a/docs/user/alerting/alerting-troubleshooting.asciidoc
+++ b/docs/user/alerting/alerting-troubleshooting.asciidoc
@@ -189,12 +189,30 @@ In addition to the above methods, refer to the following approaches and common i
 * <<event-log-index,Querying event log index>>
 * <<testing-connectors,Testing connectors using {connectors-ui} UI and the `kbn-action` tool>>
 
+[discrete]
+[[alerting-kibana-throttle]]
+==== Temporarily throttle all tasks
+
+If cluster performance becomes degraded from excessive or expensive rules and {kib} is sluggish or unresponsive, you can temporarily reduce load to the Task Manager by updating its <<task-manager-settings-kb,settings>>:
+
+[source,txt]
+--------------------------------------------------
+xpack.task_manager.max_workers: 1
+xpack.task_manager.poll_interval: 1h
+--------------------------------------------------
+
+[WARNING]
+====
+This approach should be used only temporarily as a last resort to restore function to {kib} when it is unresponsive and attempts to identify and <<controlling-rules,snooze or disable>> slow-running rules have not fixed the situation.
+It severely throttles all background tasks, not just those relating to {alert-features}. The task manager will run only one task at a time and will look for more work each hour.
+====
+
 [discrete]
 [[alerting-limitations]]
 === Limitations
 
 The following limitations and known problems apply to the {version} release of
-the {kib} {alert-features}. 
+the {kib} {alert-features}:
 
 [discrete]
 ==== Alert visibility
@@ -208,3 +226,4 @@ the `consumer` property.
 include::troubleshooting/alerting-common-issues.asciidoc[]
 include::troubleshooting/event-log-index.asciidoc[]
 include::troubleshooting/testing-connectors.asciidoc[]
+