github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 15:17:30 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Refresh screenshots for machine learning rules (#93805)

Browse source
This commit is contained in:
Lisa Cawley 2023-02-15 15:43:30 -08:00 • committed by GitHub
parent b0ba832791
commit f49bb09503
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 39 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/reference/transform/transform-alerts.asciidoc
View file

@ -27,7 +27,7 @@ On the *Create rule* window, give a name to the rule and optionally provide
tags. Select the {transform} health rule type:
[role="screenshot"]
image::images/transform-rule.png["Creating a transform health rule"]
image::images/transform-rule.png["Creating a transform health rule",500]
// NOTE: This is screenshot is automatically generated. Do not edit it directly.
[[creating-transform-health-rules]]
@ -48,37 +48,23 @@ _Errors in {transform} messages_::
Notifies if {transform} messages contain errors.
[role="screenshot"]
image::images/transform-check-config.png["Selecting health check"]
image::images/transform-check-config.png["Selecting health check",500]
// NOTE: This is screenshot is automatically generated. Do not edit it directly.
As the last step in the rule creation process, define the actions that occur when the conditions are met.
As the last step in the rule creation process, define its actions.
[[defining-actions]]
== Defining actions
Connect your rule to actions that use supported built-in integrations by
selecting a connector type. Connectors are {kib} services or third-party
integrations that perform an action when the rule conditions are met or the
alert is recovered. You can select in which case the action will run. For
example, you can choose a Slack connector and configure it to send a message to
a specific channel. Alternatively, you can create an index connector that
writes the JSON object you configure to a specific index.
After you select a connector, you must set the action frequency. Options include
running actions at each check interval, only when the alert status changes, or
at a custom action interval. For this particular type of rule, you can run
actions when an issue is detected and when it is recovered. An alert remains
active as long as the configured conditions are met during the check interval.
When there is no matching condition in the next interval, the `Recovered` action
group is invoked and the status of the alert changes to `OK`.
include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-alerts.asciidoc[tag=define-actions]
It's also possible to customize the notification messages for each action. A
list of variables is available to include in the message, like {transform} ID,
description, {transform} state, and so on.
[role="screenshot"]
image::images/transform-alert-actions.png["Selecting connector type"]
image::images/transform-alert-actions.png["Selecting connector type",500]
// NOTE: This is screenshot is automatically generated. Do not edit it directly.
After you save the configurations, the rule appears in the *{rules-ui}* list