From cdeb8b6cb7443a6da5ca82c8acfafe3b67472664 Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Tue, 19 Nov 2024 03:49:33 +1100
Subject: [PATCH] [8.x] Update doc on ruleTaskTimeout to mention requests to
 Elasticsearch also receive the same timeout, up to 5m (#200172) (#200587)
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.x`:
- [Update doc on ruleTaskTimeout to mention requests to Elasticsearch
also receive the same timeout, up to 5m
(#200172)](https://github.com/elastic/kibana/pull/200172)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Mike
Côté","email":"mikecote@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-11-18T15:00:42Z","message":"Update
doc on ruleTaskTimeout to mention requests to Elasticsearch also receive
the same timeout, up to 5m (#200172)\n\nUpdating the docs to mention
ruleTaskTimeout also affects requests made\r\nto
Elasticsearch\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"f94bb3354f605ad59ab9d7c8ca7db2166f24b9fc","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Task
Manager","Team:ResponseOps","v9.0.0","backport:prev-minor","v8.17.0"],"title":"Update
doc on ruleTaskTimeout to mention requests to Elasticsearch also receive
the same timeout, up to
5m","number":200172,"url":"https://github.com/elastic/kibana/pull/200172","mergeCommit":{"message":"Update
doc on ruleTaskTimeout to mention requests to Elasticsearch also receive
the same timeout, up to 5m (#200172)\n\nUpdating the docs to mention
ruleTaskTimeout also affects requests made\r\nto
Elasticsearch\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"f94bb3354f605ad59ab9d7c8ca7db2166f24b9fc"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/200172","number":200172,"mergeCommit":{"message":"Update
doc on ruleTaskTimeout to mention requests to Elasticsearch also receive
the same timeout, up to 5m (#200172)\n\nUpdating the docs to mention
ruleTaskTimeout also affects requests made\r\nto
Elasticsearch\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"f94bb3354f605ad59ab9d7c8ca7db2166f24b9fc"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
---
 x-pack/plugins/alerting/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/x-pack/plugins/alerting/README.md b/x-pack/plugins/alerting/README.md
index b14f2e30202b7..5139b05d4f4fa 100644
--- a/x-pack/plugins/alerting/README.md
+++ b/x-pack/plugins/alerting/README.md
@@ -92,7 +92,7 @@ The following table describes the properties of the `options` object.
 |executor|This is where the code for the rule type lives. This is a function to be called when executing a rule on an interval basis. For full details, see the executor section below.|Function|
 |producer|The id of the application producing this rule type.|string|
 |minimumLicenseRequired|The value of a minimum license. Most of the rules are licensed as "basic".|string|
-|ruleTaskTimeout|(Optional) The length of time a rule can run before being cancelled due to timeout. If not specified, the default value of "5m" is used.|string|
+|ruleTaskTimeout|(Optional) The length of time a rule can run before being cancelled due to timeout. If not specified, the default value of "5m" is used. Requests made to Elasticsearch will also receive the same timeout configuration, up to 5m.|string|
 |cancelAlertsOnRuleTimeout|(Optional) Whether to skip writing alerts and scheduling actions if a rule execution is cancelled due to timeout. If not specified, the default value of "true" is used.|boolean|
 |useSavedObjectReferences.extractReferences|(Optional) When developing a rule type, you can choose to implement hooks for extracting saved object references from rule parameters. This hook will be invoked when a rule is created or updated. Implementing this hook is optional, but if an extract hook is implemented, an inject hook must also be implemented.|Function
 |useSavedObjectReferences.injectReferences|(Optional) When developing a rule type, you can choose to implement hooks for injecting saved object references into rule parameters. This hook will be invoked when a rule is retrieved (get or find). Implementing this hook is optional, but if an inject hook is implemented, an extract hook must also be implemented.|Function