Skip to content

Commit c597d48

Browse files
kibanamachinelcawl
andauthored
[8.9] [DOCS] Add conditional actions to Observability rule screenshots (elastic#162284) (elastic#163851)
# Backport This will backport the following commits from `main` to `8.9`: - [[DOCS] Add conditional actions to Observability rule screenshots (elastic#162284)](elastic#162284) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-08-14T18:16:39Z","message":"[DOCS] Add conditional actions to Observability rule screenshots (elastic#162284)","sha":"bd6d65591a5bd2f465d3761b107501f24eab973d","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:prev-minor","v8.10.0"],"number":162284,"url":"https://github.com/elastic/kibana/pull/162284","mergeCommit":{"message":"[DOCS] Add conditional actions to Observability rule screenshots (elastic#162284)","sha":"bd6d65591a5bd2f465d3761b107501f24eab973d"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/162284","number":162284,"mergeCommit":{"message":"[DOCS] Add conditional actions to Observability rule screenshots (elastic#162284)","sha":"bd6d65591a5bd2f465d3761b107501f24eab973d"}}]}] BACKPORT--> Co-authored-by: Lisa Cawley <[email protected]>
1 parent 2305a34 commit c597d48

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

docs/user/alerting/create-and-manage-rules.asciidoc

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,28 @@ conditions are met and when they are no longer met.
7171

7272
Each action uses a connector, which provides connection information for a {kib} service or third party integration, depending on where you want to send the notifications. If no connectors exist, click **Add connector** to create one.
7373

74-
After you select a connector, set the action frequency. If the rule type supports alert summaries, you can choose to create a summary of alerts on each check interval or on a custom interval. For example, if you create a metrics threshold rule, you can send email notifications that summarize the new, ongoing, and recovered alerts each day:
74+
After you select a connector, set the action frequency. If the rule type supports alert summaries, you can choose to create a summary of alerts on each check interval or on a custom interval. For example, if you create a metrics threshold rule, you can send email notifications that summarize the new, ongoing, and recovered alerts each hour:
7575

7676
[role="screenshot"]
77-
image::images/rule-flyout-action-summary.png[UI for defining rule conditions on a metric threshold rule,500]
77+
image::images/action-alert-summary.png[UI for defining rule conditions on a metric threshold rule,500]
78+
// NOTE: This is an autogenerated screenshot. Do not edit it directly.
7879

79-
TIP: If you choose a custom action interval, it cannot be shorter than the rule's check interval.
80+
[NOTE]
81+
====
82+
* The rules that support alert summaries, such as this metric threshold rule, enable you to further refine when actions run by adding time frame and query filters.
83+
* If you choose a custom action interval, it cannot be shorter than the rule's check interval.
84+
====
8085

81-
Alternatively, you can set the action frequency such that the action runs for each alert. If the rule type does not support alert summaries, this is your only available option. You must choose when the action runs (for example, at each check interval, only when the alert status changes, or at a custom action interval). You must also choose an action group, which affects whether the action runs (for example, the action runs when the issue is detected or when it is recovered). Each rule type has a specific set of valid action groups.
86+
Alternatively, you can set the action frequency such that the action runs for each alert.
87+
If the rule type does not support alert summaries, this is your only available option.
88+
You must choose when the action runs (for example, at each check interval, only when the alert status changes, or at a custom action interval).
89+
You must also choose an action group, which affects whether the action runs. Each rule type has a specific set of valid action groups.
90+
For example, you can set *Run when* to `Alert`, `Warning`, `No data`, or `Recovered` for the metric threshold rule:
8291

8392
[role="screenshot"]
8493
image::images/rule-flyout-action-details.png[UI for defining an email action,500]
8594
// NOTE: This is an autogenerated screenshot. Do not edit it directly.
8695

87-
If you create rules in the {security-app}, you can further refine when actions run by adding time frame and query filters.
88-
For more details, refer to {security-guide}/rules-ui-create.html[Create a detection rule].
89-
9096
Each connector enables different action properties. For example, an email connector enables you to set the recipients, the subject, and a message body in markdown format. For more information about connectors, refer to <<action-types>>.
9197

9298
[[alerting-concepts-suppressing-duplicate-notifications]]
69.6 KB
Loading
-53.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)