Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The max_signals field for rules can support up to 1000 alerts #3293

Merged
merged 8 commits into from
May 22, 2023
Merged

The max_signals field for rules can support up to 1000 alerts #3293

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b01c559
First draft
nastasha-solomon May 16, 2023
891b001
Merge branch 'main' into issue-3254-max_signals
nastasha-solomon May 16, 2023
8506e3f
Merge branch 'main' into issue-3254-max_signals
nastasha-solomon May 17, 2023
b617529
Update docs/detections/api/rules/rules-api-create.asciidoc
nastasha-solomon May 20, 2023
ea34374
Merge branch 'main' into issue-3254-max_signals
nastasha-solomon May 20, 2023
0f2c4b3
Merge branch 'main' into issue-3254-max_signals
nastasha-solomon May 22, 2023
a45c7da
Merge branch 'main' into issue-3254-max_signals
nastasha-solomon May 22, 2023
0ffa72e
Merge branch 'main' into issue-3254-max_signals
nastasha-solomon May 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/detections/api/rules/rules-api-create.asciidoc
View file
Open in desktop
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