[DOCS] Refresh screenshots for transform health rules (#93761)

This commit is contained in:
Lisa Cawley 2023-02-14 10:11:49 -08:00 committed by GitHub
parent e1ed40671e
commit 2c4ef7c26a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 25 additions and 22 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 210 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 193 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Before After
Before After

View file

@ -24,19 +24,11 @@ The following {transform} rules are available:
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. Specify the time interval for the rule to check {transform} health
changes. You can also select a notification option with the _Notify_ selector.
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`.
For more details, refer to the documentation of
{kibana-ref}/create-and-manage-rules.html#defining-rules-general-details[general rule details].
Select the {transform-cap} health rule type under the Stack Monitoring section.
tags. Select the {transform} health rule type:
[role="screenshot"]
image::images/transform-rule.png["Creating a transform health rule"]
// NOTE: This is screenshot is automatically generated. Do not edit it directly.
[[creating-transform-health-rules]]
=== {transform-cap} health
@ -52,12 +44,14 @@ _{transform-cap} is not started_::
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"]
// NOTE: This is screenshot is automatically generated. Do not edit it directly.
As the last step in the rule creation process,
<<defining-actions, define the actions>> that occur when the conditions
are met.
As the last step in the rule creation process, define the actions that occur when the conditions are met.
[[defining-actions]]
@ -66,17 +60,26 @@ are met.
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.
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`.
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"]
For example, you can choose _Slack_ as a connector type and configure it to send
a message to a channel you selected. You can also create an index connector that
writes the JSON object you configure to a specific index. It's also possible to
customize the notification messages. A list of variables is available to include
in the message, like {transform} ID, description, {transform} state, and so on.
// 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
@ -85,4 +88,4 @@ 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.
open it via *{rules-ui}* by selecting the rule name.