Skip to content

Commit

Permalink
[8.8] Snoozing alert notifications for detection rules (backport #3217)…
Browse files Browse the repository at this point in the history
… (#3308)

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
  • Loading branch information
3 people authored May 18, 2023
1 parent 993eb4a commit 6dbe2ef
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
Binary file added docs/detections/images/rule-snoozing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 19 additions & 2 deletions docs/detections/rules-ui-manage.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ On the Rules page, you can:
* <<rule-prerequisites>>
* <<edit-rules-settings>>
* <<manage-rules-ui>>
* <<snooze-rule-actions>>
* <<import-export-rules-ui>>
* <<troubleshoot-signals>>

Expand Down Expand Up @@ -141,15 +142,17 @@ NOTE: The action frequency you select applies to all actions (both new and exist

** *Update rule schedules*: Update the <<rule-schedule,schedules>> and look-back times on all selected rules.
** *Apply Timeline template*: Apply a specified <<timeline-templates-ui, Timeline template>> to the selected rules. You can also choose *None* to remove Timeline templates from the selected rules.
. On the flyout that opens, update the settings.
. On the flyout that opens, update the rule settings and actions.
+
TIP: To <<snooze-rule-actions,snooze>> rule actions, go to the *Actions* tab and click the bell icon.
. If available, select *Overwrite all selected _x_* to overwrite the settings on the rules. For example, if you're adding tags to multiple rules, selecting *Overwrite all selected rules tags* removes all the rules' original tags and replaces them with the tags you specify.
. Click *Save*.

[float]
[[manage-rules-ui]]
=== Manage rules

You can duplicate, enable, disable, and delete rules:
You can duplicate, enable, disable, delete, and snooze actions for rules:

NOTE: When duplicating a rule with exceptions, you can choose to duplicate the rule and its exceptions (active and expired), the rule and active exceptions only, or only the rule. If you duplicate the rule and its exceptions, copies of the exceptions are created and added to the duplicated rule's <<detections-ui-exceptions,default rule list>>. If the original rule used exceptions from a shared exception list, the duplicated rule will reference the same shared exception list.

Expand All @@ -158,6 +161,20 @@ NOTE: When duplicating a rule with exceptions, you can choose to duplicate the r
* Select the *All actions* menu (*...*) on a rule, then select an action.
* Select all the rules you want to modify, then select an action from the *Bulk actions* menu.
* To enable or disable a single rule, switch on the rule's *Enabled* toggle.
* To <<snooze-rule-actions,snooze>> actions for rules, click the bell icon.

[float]
[[snooze-rule-actions]]
=== Snooze rule actions

Instead of turning rules off to stop alert notifications, you can snooze rule actions for a specified time period. When you snooze rule actions, the rule continues to run on its defined schedule, but won't perform any actions or send alert notifications.

You can snooze notifications temporarily or indefinitely. When actions are snoozed, you can cancel or change the duration of the snoozed state. You can also schedule and manage recurring downtime for actions.

You can snooze rule notifications from the Rules table, the rule details page, or the *Actions* tab when editing a rule.

[role="screenshot"]
image::images/rule-snoozing.png[Rules snooze options,65%]

[float]
[[import-export-rules-ui]]
Expand Down

0 comments on commit 6dbe2ef

Please sign in to comment.