Skip to content

Commit

Permalink
update triage threshold breaches pages
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Sep 24, 2024
1 parent 53aaf31 commit dfe4232
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 7 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
24 changes: 17 additions & 7 deletions docs/en/observability/triage-threshold-breaches.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,32 @@ 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.
* *Charts for each condition*. 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
+
image::images/log-threshold-breach-condition-chart.png[Chart for a condition in alert details for log threshold breach]

* *Log rate analysis chart*. 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.
For more information about using the log rate analysis feature,
refer to the {kibana-ref}/xpack-ml-aiops.html#log-rate-analysis[AIOps Labs] documentation.
* The page may also include an alerts history chart that shows the number of triggered alerts per day for the last 30 days.
+
image::images/log-threshold-breach-log-rate-analysis.png[Log rate analysis chart in alert details for log threshold breach]

* *Alerts history chart*. The page may also include an alerts history chart that shows the number of
triggered alerts per day for the last 30 days.
This chart is currently only available for rules that specify a single condition.
* Timelines on the page are annotated to show when the threshold was breached.
+
image::images/log-threshold-breach-alert-history-chart.png[Alert history chart in alert details for log threshold breach]

[TIP]
====
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.
Expand Down

0 comments on commit dfe4232

Please sign in to comment.