Skip to content

Commit

Permalink
The max_signals field for rules can support up to 1000 alerts (#3293)
Browse files Browse the repository at this point in the history
Co-authored-by: Joe Peeples <[email protected]>
(cherry picked from commit 4561146)
  • Loading branch information
nastasha-solomon authored and mergify[bot] committed May 22, 2023
1 parent 11684a8 commit dcdc5dc
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/detections/api/rules/rules-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -280,9 +280,11 @@ means the rule runs every hour. Defaults to `5m` (5 minutes).

|license |String |The rule's license.

|max_signals |Integer |Maximum number of alerts the rule can create during a
|max_signals |Integer a|Maximum number of alerts the rule can create during a
single execution. Defaults to `100`.

*NOTE*: To avoid rule failures, do not set the `max_signals` value higher than the value of {kibana-ref}/alert-action-settings-kb.html#alert-settings[`xpack.alerting.rules.run.alerts.max`].

|meta |Object a|Placeholder for metadata about the rule.

*NOTE*: This field is overwritten when you save changes to the rule's settings.
Expand Down

0 comments on commit dcdc5dc

Please sign in to comment.