Skip to content

Commit

Permalink
Add docs about custom threshold alert details page
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton committed May 8, 2024
1 parent 6231d4a commit 581c0bb
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 2 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ include::create-alerts.asciidoc[leveloffset=+1]
include::aggregation-options.asciidoc[leveloffset=+2]
include::view-observability-alerts.asciidoc[leveloffset=+2]
include::triage-slo-burn-rate-breaches.asciidoc[leveloffset=+3]
include::triage-threshold-breaches.asciidoc[leveloffset=+3]

//SLOs
include::slo-overview.asciidoc[leveloffset=+1]
Expand Down
4 changes: 2 additions & 2 deletions docs/en/observability/triage-slo-burn-rate-breaches.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ When this happens, you are at risk of exhausting your error budget and violating

To triage issues quickly, go to the alert details page:

. Go to **{observability}** -> **Alerts** (or open the SLO and click **Alerts**.)
. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions icon] icon next to the alert and select **View alert details**.
. Go to **{observability}** **Alerts** (or open the SLO and click **Alerts**).
. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon next to the alert and select **View alert details**.

The alert details page shows information about the alert, including when the alert was triggered,
the duration of the alert, the source SLO, and the rule that triggered the alert.
Expand Down
44 changes: 44 additions & 0 deletions docs/en/observability/triage-threshold-breaches.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[[triage-threshold-breaches]]
= Triage threshold breaches
++++
<titleabbrev>Threshold breaches</titleabbrev>
++++

Threshold breaches occur when an {observability} data type reaches or exceeds the threshold set in your <<custom-threshold-alert,custom threshold rule>>.
For example, you might have a custom threshold rule that triggers an alert when the total number of log documents with a log level of `error` reaches 100.

To triage issues quickly, go to the alert details page:

. Go to **{observability}** → **Alerts**.
. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon next to the alert and select **View alert details**.

The alert details page shows information about the alert, including when the alert was triggered,
the duration of the alert, and the last status update.
If there is a "group by" field specified in the rule, the page also includes the source.
You can follow the links to navigate to the rule definition.

Explore charts on the page to learn more about the threshold breach:

[role="screenshot"]
image::images/log-threshold-breach.png[Alert details for log threshold breach]

* The page includes a chart for each condition specified in the rule.
These charts help you understand when the breach occurred and its severity.
* If your rule is intended to detect log threshold breaches
(that is, it has a single condition that uses a count aggregation),
you can run a log rate analysis, assuming you have the required license.
Running a log rate analysis is useful for detecting significant dips or spikes in the number of logs.
Notice that you can adjust the baseline and deviation, and then run the analysis again.
* The page may also include an alerts history chart that shows the last 30 days.
This chart is currently only available for rules that specify a singe condition.
* Timelines on the page are annotated to show when the threshold was breached.
You can hover over an alert icon to see the timestamp of the alert.

Analyze these charts to better understand when the breach started, it's current
state, and how the issue is trending.

After investigating the alert, you may want to:

* Click **Snooze the rule** to snooze notifications for a specific time period or indefinitely.
* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <<create-cases>>.
* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Mark as untracked**.

0 comments on commit 581c0bb

Please sign in to comment.