@@ -24,19 +24,11 @@ The following {transform} rules are available:
2424You can create {transform} rules under **{stack-manage-app} > {rules-ui}**.
2525
2626On the *Create rule* window, give a name to the rule and optionally provide
27- tags. Specify the time interval for the rule to check {transform} health
28- changes. You can also select a notification option with the _Notify_ selector.
29- An alert remains active as long as the configured conditions are met during the
30- check interval. When there is no matching condition in the next interval, the
31- `Recovered` action group is invoked and the status of the alert changes to `OK`.
32- For more details, refer to the documentation of
33- {kibana-ref}/create-and-manage-rules.html#defining-rules-general-details[general rule details].
34-
35- Select the {transform-cap} health rule type under the Stack Monitoring section.
27+ tags. Select the {transform} health rule type:
3628
3729[role="screenshot"]
3830image::images/transform-rule.png["Creating a transform health rule"]
39-
31+ // NOTE: This is screenshot is automatically generated. Do not edit it directly.
4032
4133[[creating-transform-health-rules]]
4234=== {transform-cap} health
@@ -52,12 +44,14 @@ _{transform-cap} is not started_::
5244 any data. The notification message recommends the necessary actions to solve
5345 the error.
5446
47+ _Errors in {transform} messages_::
48+ Notifies if {transform} messages contain errors.
49+
5550[role="screenshot"]
5651image::images/transform-check-config.png["Selecting health check"]
52+ // NOTE: This is screenshot is automatically generated. Do not edit it directly.
5753
58- As the last step in the rule creation process,
59- <<defining-actions, define the actions>> that occur when the conditions
60- are met.
54+ As the last step in the rule creation process, define the actions that occur when the conditions are met.
6155
6256
6357[[defining-actions]]
@@ -66,17 +60,26 @@ are met.
6660Connect your rule to actions that use supported built-in integrations by
6761selecting a connector type. Connectors are {kib} services or third-party
6862integrations that perform an action when the rule conditions are met or the
69- alert is recovered. You can select in which case the action will run.
63+ alert is recovered. You can select in which case the action will run. For
64+ example, you can choose a Slack connector and configure it to send a message to
65+ a specific channel. Alternatively, you can create an index connector that
66+ writes the JSON object you configure to a specific index.
67+
68+ After you select a connector, you must set the action frequency. Options include
69+ running actions at each check interval, only when the alert status changes, or
70+ at a custom action interval. For this particular type of rule, you can run
71+ actions when an issue is detected and when it is recovered. An alert remains
72+ active as long as the configured conditions are met during the check interval.
73+ When there is no matching condition in the next interval, the `Recovered` action
74+ group is invoked and the status of the alert changes to `OK`.
75+
76+ It's also possible to customize the notification messages for each action. A
77+ list of variables is available to include in the message, like {transform} ID,
78+ description, {transform} state, and so on.
7079
7180[role="screenshot"]
7281image::images/transform-alert-actions.png["Selecting connector type"]
73-
74-
75- For example, you can choose _Slack_ as a connector type and configure it to send
76- a message to a channel you selected. You can also create an index connector that
77- writes the JSON object you configure to a specific index. It's also possible to
78- customize the notification messages. A list of variables is available to include
79- in the message, like {transform} ID, description, {transform} state, and so on.
82+ // NOTE: This is screenshot is automatically generated. Do not edit it directly.
8083
8184After you save the configurations, the rule appears in the *{rules-ui}* list
8285where you can check its status and see the overview of its configuration
@@ -85,4 +88,4 @@ information.
8588The name of an alert is always the same as the {transform} ID of the associated
8689{transform} that triggered it. You can mute the notifications for a particular
8790{transform} on the page of the rule that lists the individual alerts. You can
88- open it via *{rules-ui}* by selecting the rule name.
91+ open it via *{rules-ui}* by selecting the rule name.
0 commit comments