Skip to content

Commit a1ed66d

Browse files
[Response Ops][9.x & Serverless]: Improve docs for recovered status (#2597)
## Summary Contributes to #2313 and #2143 by elaborating on the logic behind the recovered alert status and providing examples of when statuses change from active -> recovered and flapping -> recovered. Rule docs for Observability and Stack Management are updated. This PR also makes the following minor changes: - Observability page updates: - Added `applies to` tags to the front matter to show that the content is relevant to Stack and Serverless users. - Moved the alert status docs to their own dedicated section for easier scanning and reference. This also makes the docs for alert statuses linkable if we ever need to reference the docs from the UI. - Minor revisions to the description for the flapping status. Also updated the note to show that alert flapping is enabled by default can can be configured if users want to modify the conditions for the flapping status. - Replaced old `svg` images of icons with the formal ones [here](https://elastic.github.io/docs-builder/syntax/icons/). **Corresponding 8.x doc updates**: - Observability - elastic/observability-docs#4949 - Kibana - elastic/kibana#232301 ## Previews [Available here](#2597 (comment))
1 parent 438e29e commit a1ed66d

File tree

2 files changed

+54
-27
lines changed

2 files changed

+54
-27
lines changed

explore-analyze/alerts-cases/alerts/view-alerts.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,38 @@ To get more information about a specific alert, open its action menu (…) and s
4747

4848
If an alert is affected by a maintenance window, the alert details include its identifier. For more information about their impact on alert notifications, refer to [*Maintenance windows*](maintenance-windows.md).
4949

50-
### Alert statuses [alert-status]
50+
## Alert statuses [alert-status]
5151

52-
There are three common alert statuses:
52+
There are four common alert statuses:
5353

5454
`active`
55-
: The conditions for the rule are met and actions should be generated according to the notification settings.
55+
: The conditions for the rule are met. If the rule has [actions](create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings.
5656

57-
`recovered`
58-
: The conditions for the rule are no longer met and recovery actions should be generated.
57+
`flapping`
5958

60-
`untracked`
61-
: Actions are no longer generated. For example, you can choose to move active alerts to this state when you disable or delete rules.
59+
: The alert is switching repeatedly between active and recovered states. If the rule has actions that run when the alert status changes states, those actions are suppressed while the alert is flapping.
6260

63-
::::{note}
64-
An alert can also be in a "flapping" state when it is switching repeatedly between active and recovered states. This state is possible only if you have enabled alert flapping detection in **{{stack-manage-app}} > {{rules-ui}} > Settings**. For each space, you can choose a look back window and threshold that are used to determine whether alerts are flapping. For example, you can specify that the alert must change status at least 6 times in the last 10 runs. If the rule has actions that run when the alert status changes, those actions are suppressed while the alert is flapping.
61+
::::{note}
62+
63+
Alert flapping is turned on by default. You can modify the criteria for changing an alert's status to the flapping state by configuring the **Alert flapping detection** settings. To do this, navigate to the **Alerts** page in the main menu, or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). Next, click **Manage Rules**, then **Settings** to open the global rule settings for the space. In the **Alert flapping detection** section, modify the rules' look back window and threshold for alert status changes. For example, you can specify that the alert must change its status at least 6 times in the last 10 runs for it to become a flapping alert.
6564

6665
::::
6766

67+
`recovered`
68+
: The conditions for the rule are no longer met. If the rule has [recovery actions](create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings. Recovery actions only run if the rule's conditions aren't met during the current rule execution, but were in the previous one.
69+
70+
71+
An active alert changes to recovered if the conditions for the rule that generated it are no longer met.
72+
73+
A flapping alert changes to recovered when the rule's conditions are unmet for a specific number of consecutive runs. This number is determined by the **Alert status change threshold** setting, which you can configure under the **Alert flapping detection** settings.
74+
75+
For example, if the threshold requires an alert to change status at least 6 times in the last 10 runs to be considered flapping, then to recover, the rule's conditions must remain unmet for 6 consecutive runs. If the rule's conditions are met at any point during this recovery period, the count of consecutive unmet runs will reset, requiring the alert to remain unmet for an additional 6 consecutive runs to finally be reported as recovered.
76+
77+
Once a flapping alert is recovered, it cannot be changed to flapping again. Only new alerts with repeated status changes are candidates for the flapping status.
78+
79+
`untracked`
80+
: The rule is disabled, or you’ve marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the {icon}`boxes_horizontal` icon to expand the **More actions** menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules.
81+
6882
## Mute alerts [mute-alerts]
6983

7084
If an alert is active or flapping, you can mute it to temporarily suppress future actions. In both **{{stack-manage-app}} > Alerts** and **{{rules-ui}}**, you can open the action menu (…) for the appropriate alert and select **Mute**. To permanently suppress actions for an alert, open the actions menu and select **Mark as untracked**.

solutions/observability/incident-management/view-alerts.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/view-observability-alerts.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-view-alerts.html
5+
applies_to:
6+
stack: all
7+
serverless:
8+
observability: all
59
products:
610
- id: observability
711
- id: cloud-serverless
@@ -50,37 +54,47 @@ From the **Alerts** table, you can click on a specific alert to open the alert d
5054
:screenshot:
5155
:::
5256

57+
To further inspect the rule:
58+
59+
* From the alert detail flyout, click **View rule details**.
60+
* From the **Alerts** table, click the {icon}`boxes_horizontal` icon and select **View rule details**.
61+
62+
To view the alert in the app that triggered it:
63+
64+
* From the alert detail flyout, click **View in app**.
65+
* From the **Alerts** table, click the {icon}`eye` icon.
66+
67+
## Understand alert statuses [observability-view-alerts-understand-statuses]
68+
5369
There are four common alert statuses:
5470

5571
`active`
56-
: The conditions for the rule are met and actions should be generated according to the notification settings.
72+
: The conditions for the rule are met. If the rule has [actions](../../../explore-analyze/alerts-cases/alerts/create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings.
5773

5874
`flapping`
59-
: The alert is switching repeatedly between active and recovered states.
6075

61-
`recovered`
62-
: The conditions for the rule are no longer met and recovery actions should be generated.
76+
: The alert is switching repeatedly between active and recovered states. If the rule has actions that run when the alert status changes states, those actions are suppressed while the alert is flapping.
6377

64-
`untracked`
65-
: The corresponding rule is disabled or you’ve marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the ![More actions](/solutions/images/serverless-boxesHorizontal.svg "") icon to expand the *More actions* menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules.
78+
::::{note}
6679

67-
::::{note}
68-
**Flapping alerts**
69-
70-
The flapping state is possible only if you have enabled alert flapping detection. Go to the **Alerts** page and click **Manage Rules** to navigate to the {{obs-serverless}} **{{rules-app}}** page. Click **Settings** then set the look back window and threshold that are used to determine whether alerts are flapping. For example, you can specify that the alert must change status at least 6 times in the last 10 runs. If the rule has actions that run when the alert status changes, those actions are suppressed while the alert is flapping.
80+
Alert flapping is turned on by default. You can modify the criteria for changing an alert's status to the flapping state by configuring the **Alert flapping detection** settings. To do this, navigate to the **Alerts** page in the main menu, or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). Next, click **Manage Rules**, then **Settings** to open the global rule settings for the space. In the **Alert flapping detection** section, modify the rules' look back window and threshold for alert status changes. For example, you can specify that the alert must change its status at least 6 times in the last 10 runs for it to become a flapping alert.
7181

7282
::::
7383

84+
`recovered`
85+
: The conditions for the rule are no longer met. If the rule has [recovery actions](../../../explore-analyze/alerts-cases/alerts/create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings. Recovery actions only run if the rule's conditions aren't met during the current rule execution, but were in the previous one.
7486

75-
To further inspect the rule:
7687

77-
* From the alert detail flyout, click **View rule details**.
78-
* From the **Alerts** table, click the ![More actions](/solutions/images/serverless-boxesHorizontal.svg "") icon and select **View rule details**.
88+
An active alert changes to recovered if the conditions for the rule that generated it are no longer met.
7989

80-
To view the alert in the app that triggered it:
90+
A flapping alert changes to recovered when the rule's conditions are unmet for a specific number of consecutive runs. This number is determined by the **Alert status change threshold** setting, which you can configure under the **Alert flapping detection** settings.
91+
92+
For example, if the threshold requires an alert to change status at least 6 times in the last 10 runs to be considered flapping, then to recover, the rule's conditions must remain unmet for 6 consecutive runs. If the rule's conditions are met at any point during this recovery period, the count of consecutive unmet runs will reset, requiring the alert to remain unmet for an additional 6 consecutive runs to finally be reported as recovered.
8193

82-
* From the alert detail flyout, click **View in app**.
83-
* From the **Alerts** table, click the ![View in app](/solutions/images/serverless-eye.svg "") icon.
94+
Once a flapping alert is recovered, it cannot be changed to flapping again. Only new alerts with repeated status changes are candidates for the flapping status.
95+
96+
`untracked`
97+
: The rule is disabled, or you’ve marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the {icon}`boxes_horizontal` icon to expand the **More actions** menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules.
8498

8599

86100
## Customize the alerts table [observability-view-alerts-customize-the-alerts-table]
@@ -98,15 +112,14 @@ You can also use the toolbar buttons in the upper-right to customize the display
98112

99113
## Add alerts to cases [observability-view-alerts-add-alerts-to-cases]
100114

101-
From the **Alerts** table, you can add one or more alerts to a case. Click the ![More actions](/solutions/images/serverless-boxesHorizontal.svg "") icon to add the alert to a new or existing case. You can add an unlimited amount of alerts from any rule type.
115+
From the **Alerts** table, you can add one or more alerts to a case. Click the {icon}`boxes_horizontal` icon to add the alert to a new or existing case. You can add an unlimited amount of alerts from any rule type.
102116

103117
::::{note}
104118
Each case can have a maximum of 1,000 alerts.
105119

106120
::::
107121

108122

109-
110123
### Add an alert to a new case [observability-view-alerts-add-an-alert-to-a-new-case]
111124

112125
To add an alert to a new case:

0 commit comments

Comments
 (0)