Skip to content

Commit 7eb8363

Browse files
authored
Merge pull request #102534 from openshift-cherrypick-robot/cherry-pick-101714-to-standalone-coo-docs-1-latest
[standalone-coo-docs-1-latest] OBSDOCS-2705 Incident detection changes
2 parents 111d550 + 3bd3812 commit 7eb8363

7 files changed

+23
-17
lines changed
143 KB
Loading
77.3 KB
Loading
124 KB
Loading
99.6 KB
Loading
168 KB
Loading

modules/coo-incident-detection-using.adoc

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,43 @@
1313
* You have installed the {coo-full}.
1414
* You have installed the {coo-full} monitoring UI plugin with incident detection enabled.
1515
16+
[NOTE]
17+
====
18+
If you have installed the {coo-full} programmatically, make sure that the namespace (by default `openshift-cluster-observability-operator`) has the label `openshift.io/cluster-monitoring=true`. If not add it by running the comand:
19+
20+
[source,terminal]
21+
----
22+
$ oc label namespace openshift-cluster-observability-operator openshift.io/cluster-monitoring=true
23+
----
24+
25+
====
26+
1627

1728
.Procedure
1829

19-
. In the Administrator perspective of the web console, click on *Observe* -> *Incidents*.
30+
. In the Administrator perspective of the web console, click on *Observe* -> *Alerting* and choose the **Incidents** tab.
2031

2132
. The Incidents Timeline UI shows the grouping of alerts into *incidents*. The color coding of the lines in the graph corresponds to the severity of the incident. By default, a seven day timeline is presented.
2233
+
2334
image::coo-incidents-timeline-weekly.png[Weekly incidents timeline]
2435
+
2536
[NOTE]
2637
====
27-
It will take at least 10 minutes to process the correlations and to see the timeline, after you enable incident detection.
38+
It will take at least five minutes to process the correlations and to see the timeline, after you enable incident detection.
39+
40+
Status changes are recorded at five-minute intervals. You can see the last update time next to the timeline.
2841

2942
The analysis and grouping into incidents is performed only for alerts that are firing after you have enabled this feature. Alerts that have been resolved before feature enablement are not included.
3043
====
3144

3245
. Zoom in to a 1-day view by clicking on the drop-down to specify the duration.
3346
+
3447
image::coo-incidents-timeline-daily.png[Daily incidents timeline]
48+
+
49+
[NOTE]
50+
====
51+
For performance reasons, the UI only loads the displayed data. The start time reflects the first data point rendered in the current timeline, not the absolute start time of the alert. For example, if you zoom to 1-day and an alert started two days ago, the start time will be shifted to twenty four hours before.
52+
====
3553

3654
. By clicking on an incident, you can see the timeline of alerts that are part of that incident, in the Alerts Timeline UI.
3755
+
@@ -41,18 +59,9 @@ image::coo-incident-alerts-timeline.png[Incidents alerts timeline]
4159
+
4260
image::coo-incident-alerts-components.png[Incidents alerts components]
4361

44-
. Click to expand a compute component in the list. The underlying alerts related to that component are displayed.
62+
. Click to expand a component in the list. The underlying alerts related to that component are displayed.
4563
+
4664
image::coo-incident-alerts-components-expanded.png[Incidents expanded components]
4765

48-
. Click the link for a firing alert, to see detailed information about that alert.
49-
50-
51-
52-
[NOTE]
53-
====
54-
**Known issues**
55-
56-
* Depending on the order of the timeline bars, the tooltip might overlap and hide the underlying bar. You can still click the bar and select the incident or alert.
66+
. Click the link for an alert, to see detailed information about the associated alert rule.
5767

58-
====

ui_plugins/monitoring-ui-plugin.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
:FeatureName: The {coo-full} monitoring UI plugin
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
11-
129
The monitoring UI plugin adds monitoring features to the Administrator perspective of the {ocp-product-title} web console.
1310

1411
include::snippets/unified-perspective-web-console.adoc[]
@@ -17,7 +14,7 @@ include::snippets/unified-perspective-web-console.adoc[]
1714
1815
* **Incident detection:** The incident detection feature groups related alerts into incidents, to help you identify the root causes of alert bursts, instead of being overwhelmed by individual alerts. It presents a timeline of incidents, color-coded by severity, and you can drill down into the individual alerts within an incident. The system also categorizes alerts by affected component, grouped by severity. This helps you focus on the most critical areas first.
1916
+
20-
The incident detection feature is available in the {ocp-product-title} web console at **Observe** -> **Incidents**.
17+
The incident detection feature is available in the {ocp-product-title} web console by clicking on **Observe** -> **Alerting** and choosing the **Incidents** tab.
2118
2219
include::modules/coo-monitoring-ui-plugin-install.adoc[leveloffset=+1]
2320

0 commit comments

Comments
 (0)