Skip to content

Commit 89389ea

Browse files
Restore toc entries; comment out cross-refs to rules PR and missing images
1 parent a4fdfbb commit 89389ea

4 files changed

Lines changed: 21 additions & 1 deletion

File tree

explore-analyze/alerting/kibana-alerting-experimental/alerts.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ inactive → pending → active → recovering → inactive
3030
| Active | Problem confirmed and ongoing. This is when you get notified. |
3131
| Recovering | Errors have stopped, but the system is waiting to confirm it's truly resolved. |
3232

33+
<!-- TODO: Uncomment when PR #6523 (rules) is merged:
3334
Activation and recovery thresholds control how many consecutive evaluations must agree, or how long the condition must persist, before transitioning. Refer to [Configure a rule](rules/configure-a-rule.md#activation-recovery-thresholds) to learn more about these settings.
35+
-->
36+
Activation and recovery thresholds control how many consecutive evaluations must agree, or how long the condition must persist, before transitioning.
3437

3538
### Example: First breach opens, first clear closes
3639

@@ -43,9 +46,11 @@ A checkout-latency rule runs in Alert mode every 5 minutes. Latency breaches at
4346

4447
One problem is tracked in one episode, even though the rule evaluated many times while the condition was ongoing.
4548

49+
<!-- TODO: Add image once alert-episode-example-without-threshold.png is available in explore-analyze/images/
4650
:::{image} ../../images/alert-episode-example-without-threshold.png
4751
:alt: Timeline of a checkout-latency alert episode without thresholds. At 14:05, p95 jumps to 3.1s and the episode opens immediately as active. It stays active through 14:45. At 14:50, p95 drops back under 2s and the episode resolves immediately as inactive.
4852
:::
53+
-->
4954

5055
### Example: Waiting for confirmation before opening and closing
5156

@@ -60,9 +65,11 @@ The same checkout-latency rule, now with an activation threshold of 2 consecutiv
6065

6166
Thresholds prevent brief spikes from opening episodes and transient dips from closing them prematurely. The episode waits in `pending` until the problem is confirmed, and waits in `recovering` until the resolution is confirmed.
6267

68+
<!-- TODO: Add image once alert-episode-example-with-activation-threshold.png is available in explore-analyze/images/
6369
:::{image} ../../images/alert-episode-example-with-activation-threshold.png
6470
:alt: Timeline of a checkout-latency alert episode with activation threshold of 2 and recovery threshold of 2. At 14:05, the first breach puts the episode in pending. At 14:10, the second consecutive breach moves it to active. At 14:50, the first clean check moves it to recovering. At 14:55, the second consecutive clear resolves it to inactive.
6571
:::
72+
-->
6673

6774
## Series
6875

@@ -72,7 +79,9 @@ Your rule monitors services. Each service it tracks has its own series, one for
7279

7380
Think of it like a patient's medical file. The file exists as long as the patient is in the system. Individual health incidents come and go, but the file persists.
7481

82+
<!-- TODO: Uncomment when PR #6523 (rules) is merged:
7583
For the fields that identify a series in alert event documents, refer to [Rule event and field reference](rules/rule-event-field-reference.md#rule-reference).
84+
-->
7685

7786
### How series and episodes relate
7887

explore-analyze/alerting/kibana-alerting-experimental/alerts/alert-states-and-fields-reference.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ description: "Reference for episode status, `.rule-events` row status, and `.ale
1111
# Alert states and fields reference [alert-states-reference]
1212

1313

14-
Alert states and fields are part of the experimental alerting features in Kibana. Use these tables when you read alert UI state, query `.rule-events` or `.alert-actions` in Discover, or align API payloads with what operators see. For triage controls (acknowledge, snooze, resolve, tags) and how they map to storage, refer to [Alert actions](view-and-manage-alerts.md#alert-actions). For rule evaluation fields on `.rule-events`, refer to [Rule event and field reference](../rules/rule-event-field-reference.md#rule-reference).
14+
Alert states and fields are part of the experimental alerting features in Kibana. Use these tables when you read alert UI state, query `.rule-events` or `.alert-actions` in Discover, or align API payloads with what operators see. For triage controls (acknowledge, snooze, resolve, tags) and how they map to storage, refer to [Alert actions](view-and-manage-alerts.md#alert-actions).
15+
<!-- TODO: Uncomment when PR #6523 (rules) is merged:
16+
For rule evaluation fields on `.rule-events`, refer to [Rule event and field reference](../rules/rule-event-field-reference.md#rule-reference).
17+
-->
1518

1619
## Episode status
1720

explore-analyze/alerting/kibana-alerting-experimental/alerts/query-alerts-and-signals-in-discover.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,8 @@ To use this page, open Discover, select {{esql}}, paste a query from the example
2222
<!--[CONTENT NEEDED for M2: Review and expand the query examples below once M2 field renames (`group_hash` → `series.key`, new `series.tracked_by`, `episode.severity`, `episode.severity_max`) are finalized. Add examples that take advantage of the new first-class severity and series fields.]
2323
-->
2424

25+
For field names, types, and episode fields, refer to [Alert states and fields reference](alert-states-and-fields-reference.md#alert-states-reference). For triage in the product UI, refer to [View, manage, and reference alerts](view-and-manage-alerts.md).
26+
<!-- TODO: Uncomment when PR #6523 (rules) is merged and restore full sentence:
2527
For field names, types, and episode fields, refer to [Alert states and fields reference](alert-states-and-fields-reference.md#alert-states-reference) and [Rule event and field reference](../rules/rule-event-field-reference.md#rule-reference). For triage in the product UI, refer to [View, manage, and reference alerts](view-and-manage-alerts.md).
28+
-->
2629

explore-analyze/toc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,11 @@ toc:
380380
- file: report-and-share/reporting-troubleshooting-pdf.md
381381
- file: alerting.md
382382
children:
383+
- file: alerting/kibana-alerting-experimental/alerts.md
384+
children:
385+
- file: alerting/kibana-alerting-experimental/alerts/view-and-manage-alerts.md
386+
- file: alerting/kibana-alerting-experimental/alerts/alert-states-and-fields-reference.md
387+
- file: alerting/kibana-alerting-experimental/alerts/query-alerts-and-signals-in-discover.md
383388
- file: alerting/alerts.md
384389
children:
385390
- file: alerting/alerts/alerting-getting-started.md

0 commit comments

Comments
 (0)