Skip to content

OBSDOCS-2705 Incident detection changes #101714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: standalone-coo-docs-main
Choose a base branch
from
Open

OBSDOCS-2705 Incident detection changes #101714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions modules/coo-incident-detection-using.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,45 @@
* You have installed the {coo-full}.
* You have installed the {coo-full} monitoring UI plugin with incident detection enabled.

[NOTE]
====
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:

[source,terminal]
----
$ oc label namespace openshift-cluster-observability-operator openshift.io/cluster-monitoring=true
----

====


.Procedure

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

. 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.
+
image::coo-incidents-timeline-weekly.png[Weekly incidents timeline]
+
[NOTE]
====
It will take at least 10 minutes to process the correlations and to see the timeline, after you enable incident detection.
It will take at least five minutes to process the correlations and to see the timeline, after you enable incident detection.

Status changes are recorded at five-minute intervals. You can see the last update time next to the timeline.

Zoom in to a 1-day view by clicking on the drop-down to specify the duration.

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.
====

. Zoom in to a 1-day view by clicking on the drop-down to specify the duration.
+
image::coo-incidents-timeline-daily.png[Daily incidents timeline]
+
[NOTE]
====
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.
====

. By clicking on an incident, you can see the timeline of alerts that are part of that incident, in the Alerts Timeline UI.
+
Expand All @@ -47,12 +67,3 @@ image::coo-incident-alerts-components-expanded.png[Incidents expanded components

. Click the link for a firing alert, to see detailed information about that alert.



[NOTE]
====
**Known issues**

* 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.

====