Skip to content

Commit d67d16b

Browse files
authored
[DOCS] Management: Updated Watcher docs to show new buttons (#20446) (#20652)
1 parent 2d3e66d commit d67d16b

File tree

4 files changed

+15
-19
lines changed

4 files changed

+15
-19
lines changed
215 KB
Loading

docs/management/watcher-ui/create-advanced-watch.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,15 @@
44
Advanced watches are for people who are more familiar with Elasticsearch query syntax and the watcher framework overall. The creation UI is more closely aligned with using the REST apis directly. For
55
more information, see {ref}/query-dsl.html[Query DSL].
66

7-
To create a new advanced watch:
7+
To create an advanced watch:
88

9-
. Select the `Create new watch` button
10-
image:management/watcher-ui/images/advanced-watch/advanced-watch-select.png["Create a Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-select.png"]
11-
12-
. Select `Advanced Watch`
9+
* Click the *Create advanced watch* button.
1310

1411
==== Advanced Watch UI
1512

1613
This screen lets you define the core properties of an advanced watch.
1714

15+
[role="screenshot"]
1816
image:management/watcher-ui/images/advanced-watch/advanced-watch-create.png["Create Advanced Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-create.png"]
1917

2018
The `ID` refers to the identifier used by Elasticsearch, whereas `Name` is the more user-friendly way to identify the watch. Refer to the
@@ -24,6 +22,7 @@ for the Watch JSON.
2422
[float]
2523
=== Simulate
2624

25+
[role="screenshot"]
2726
image:management/watcher-ui/images/advanced-watch/advanced-watch-simulate.png["Simulate Advanced Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-simulate.png"]
2827

2928
This screen allows you to override parts of the watch and then run a simulation of it.
@@ -40,6 +39,7 @@ Some implementation details on overrides:
4039

4140
After starting the simulation, the UI will show a results screen.
4241

42+
[role="screenshot"]
4343
image:management/watcher-ui/images/advanced-watch/advanced-watch-simulated.png["Simulated Advanced Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-simulated.png"]
4444

4545
The possible simulation statuses for watches are:

docs/management/watcher-ui/create-threshold-alert.asciidoc

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,29 @@
33

44
You can create a threshold alert to periodically check when your data goes above or below a certain threshold within a given time interval. It's one of the most common type of alerts that you can create using Watcher. For more advanced watches, see the <<watcher-create-advanced-watch>>.
55

6-
To create a new threshold alert:
6+
To create a threshold alert:
77

8-
. Select the `Create new watch` button
9-
image:management/watcher-ui/images/create-watch-select.png["Create a Watch",link="management/watcher-ui/images/create-watch-select.png"]
10-
11-
. Select `Threshold Alert`
12-
13-
Next, let's look at the UI and how to use it.
8+
* Click the *Create threshold alert* button.
149

1510
==== Inputs & Triggers
1611

17-
To create a threshold alert, you need to first configure the inputs and triggers.
12+
You must first configure the inputs and triggers.
1813

1914
. Add a `name` for the alert.
2015
. Choose one or more indices that have a time-based field as the alert input.
2116
. Configure a trigger interval.
22-
17+
+
18+
[role="screenshot"]
2319
image:management/watcher-ui/images/threshold-alert/create-threshold-alert-created.png["Created Threshold Alert",link="management/watcher-ui/images/threshold-alert/create-threshold-alert-created.png"]
2420

25-
Next, you will be able to specify the conditions to trigger the alert.
26-
2721
==== Condition
2822

2923
Here, you can configure the condition that will cause alert to trigger. The UI is interactive and selecting the various elements within the expression will display a UI to change the values.
3024

25+
[role="screenshot"]
3126
image:management/watcher-ui/images/threshold-alert/threshold-alert-aggType.png["Threshold Alert Agg Type",link="management/watcher-ui/images/threshold-alert/threshold-alert-aggType.png"]
3227

33-
Let's look at a few examples of common alerts based on x-pack monitoring data:
28+
Here are a few examples of common alerts based on x-pack monitoring data:
3429

3530
* High heap usage:
3631
image:management/watcher-ui/images/threshold-alert/high-heap-usage.png["Threshold Alert Example High Heap Usage",link="management/watcher-ui/images/threshold-alert/high-heap-usage.png"]

docs/management/watcher-ui/getting-started.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ To access {watcher} UI within {kib}:
1010
locally, go to `http://localhost:5601/`.
1111

1212
. Click **Management** in the side navigation, then select **Watcher** under `Elasticsearch`.
13-
14-
image::management/watcher-ui/images/watches.png["Watch list",link="management/watcher-ui/images/watches.png"]
13+
+
14+
[role="screenshot"]
15+
image::images/management-watcher-buttons.png["Watch list",link="management/watcher-ui/images/watches.png"]
1516

1617
The watch list page within {watcher} UI enables you to view all existing watches including stateful information about each watch. This includes `State`, `Last Fired` and `Last Triggered`.
1718

0 commit comments

Comments
 (0)