Skip to content

Commit

Permalink
[8.9] [DOCS] Add conditional actions to Observability rule screenshots (
Browse files Browse the repository at this point in the history
#162284) (#163851)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Add conditional actions to Observability rule screenshots
(#162284)](#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
(#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
(#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
(#162284)","sha":"bd6d65591a5bd2f465d3761b107501f24eab973d"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
kibanamachine and lcawl authored Oct 27, 2023
1 parent 2305a34 commit c597d48
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions docs/user/alerting/create-and-manage-rules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,28 @@ conditions are met and when they are no longer met.

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.

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:
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:

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

TIP: If you choose a custom action interval, it cannot be shorter than the rule's check interval.
[NOTE]
====
* 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.
* If you choose a custom action interval, it cannot be shorter than the rule's check interval.
====

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.
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. Each rule type has a specific set of valid action groups.
For example, you can set *Run when* to `Alert`, `Warning`, `No data`, or `Recovered` for the metric threshold rule:

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

If you create rules in the {security-app}, you can further refine when actions run by adding time frame and query filters.
For more details, refer to {security-guide}/rules-ui-create.html[Create a detection rule].

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>>.

[[alerting-concepts-suppressing-duplicate-notifications]]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.

0 comments on commit c597d48

Please sign in to comment.