mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
94 lines
3.8 KiB
Text
94 lines
3.8 KiB
Text
[role="xpack"]
|
|
[[transform-alerts]]
|
|
= Generating alerts for {transforms}
|
|
|
|
beta::[]
|
|
|
|
{kib} {alert-features} include support for {transform} rules, which check the
|
|
health of {ctransforms} with certain conditions. If the conditions of the rule
|
|
are met, an alert is created and the associated action is triggered. For
|
|
example, you can create a rule to check if a {ctransform} is started and to
|
|
notify you in an email if it is not. To learn more about {kib} {alert-features},
|
|
refer to
|
|
{kibana-ref}/alerting-getting-started.html#alerting-getting-started[Alerting].
|
|
|
|
The following {transform} rules are available:
|
|
|
|
{transform-cap} health::
|
|
Monitors {transforms} health and alerts if an operational issue occurred.
|
|
|
|
|
|
[[creating-transform-rules]]
|
|
== Creating a rule
|
|
|
|
You can create {transform} rules under **{stack-manage-app} > {rules-ui}**.
|
|
|
|
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",500]
|
|
// NOTE: This is screenshot is automatically generated. Do not edit it directly.
|
|
|
|
[[creating-transform-health-rules]]
|
|
=== {transform-cap} health
|
|
|
|
Select the {transform} or {transforms} to include. You can also use a special
|
|
character (`*`) to apply the rule to all your {transforms}. {transforms-cap}
|
|
created after the rule are automatically included.
|
|
|
|
The following health check is available and enabled by default:
|
|
|
|
_{transform-cap} is not started_::
|
|
Notifies if the corresponding {transforms} is not started or it does not index
|
|
any data. The notification message recommends the necessary actions to solve
|
|
the error.
|
|
|
|
_Errors in {transform} messages_::
|
|
Notifies if {transform} messages contain errors.
|
|
|
|
[role="screenshot"]
|
|
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 its actions.
|
|
|
|
|
|
[[defining-actions]]
|
|
== Defining actions
|
|
|
|
You can add one or more actions to your rule to generate notifications when its
|
|
conditions are met and when they are no longer met.
|
|
|
|
Each action uses a connector, which stores connection information for a {kib}
|
|
service or supported third-party integration, depending on where you want to
|
|
send the notifications. For example, you can use a Slack connector to send a
|
|
message to a channel. Or you can use an index connector that writes an JSON
|
|
object to a specific index. For details about creating connectors, refer to
|
|
{kibana-ref}/action-types.html[Connectors].
|
|
|
|
You must set the action frequency, which involves choosing how often to run
|
|
the action (for example, at each check interval, only when the alert status
|
|
changes, or at a custom action interval). Each rule type also has a list of
|
|
valid action groups and you must choose one of these groups (for example, the
|
|
action runs when the issue is detected or when it is recovered).
|
|
|
|
TIP: If you choose a custom action interval, it cannot be shorter than the
|
|
rule's check interval.
|
|
|
|
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",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
|
|
where you can check its status and see the overview of its configuration
|
|
information.
|
|
|
|
The name of an alert is always the same as the {transform} ID of the associated
|
|
{transform} that triggered it. You can mute the notifications for a particular
|
|
{transform} on the page of the rule that lists the individual alerts. You can
|
|
open it via *{rules-ui}* by selecting the rule name.
|