github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add warning for max alerts circuit breaker (#164217)

Browse source 
In this PR, I'm adding a warning message to the docs for the
`xpack.alerting.rules.run.alerts.max` setting that indicates the
consequences when setting a value higher than the default, while also
indicating it's not supported.

<img width="862" alt="Screenshot 2023-08-21 at 5 03 52 PM"
src="46a7f5d6-f6d5-475a-ab93-edf256eb9141">

cc @lcawl

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Mike Côté 2023-08-22 07:01:29 -04:00 • committed by GitHub
parent e98b4b3e88
commit 327af6ca2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/settings/alert-action-settings.asciidoc
View file

@ -245,6 +245,8 @@ Specifies the maximum number of actions that a rule can generate each time detec
`xpack.alerting.rules.run.alerts.max` {ess-icon}::
Specifies the maximum number of alerts that a rule can generate each time detection checks run. Default: 1000.
+
WARNING: The exact number of alerts your cluster can safely handle depends on your cluster configuration and workload, however setting a value higher than the default (`1000`) is not recommended or supported. Doing so could strain system resources and lead to performance issues, delays in alert processing, and potential disruptions during high alert activity periods.
`xpack.alerting.rules.run.timeout` {ess-icon}::
Specifies the default timeout for tasks associated with all types of rules.