Skip to content

Commit b65fe15

Browse files
gabriel-rhgabriel-rh
committed
OBSDOCS-1751 incident detection ui plugin
1 parent fbdda19 commit b65fe15

6 files changed

+84
-2
lines changed

‎_topic_maps/_topic_map.yml

+2
Original file line numberDiff line numberDiff line change
@@ -2915,6 +2915,8 @@ Topics:
29152915
File: distributed-tracing-ui-plugin
29162916
- Name: Troubleshooting UI plugin
29172917
File: troubleshooting-ui-plugin
2918+
- Name: Incident detection UI plugin
2919+
File: incident-detection-ui-plugin
29182920
# - Name: Dashboard UI plugin
29192921
# File: dashboard-ui-plugin
29202922
- Name: Monitoring

‎modules/coo-distributed-tracing-ui-plugin-install.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc
44

55
:_mod-docs-content-type: PROCEDURE
6-
[id="coo-distributed-tracing-ui-plugin-install-_{context}"]
6+
[id="coo-distributed-tracing-ui-plugin-install_{context}"]
77
= Installing the {coo-full} distributed tracing UI plugin
88

99

‎modules/coo-incident-detection-ui-plugin-install.adoc

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
3+
// * observability/cluster_observability_operator/ui_plugins/incident-detection-ui-plugin.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="coo-incident-detection-ui-plugin-install_{context}"]
7+
= Installing the {coo-full} incident detection UI plugin
8+
9+
10+
.Prerequisites
11+
12+
* You have access to the cluster as a user with the `cluster-admin` cluster role.
13+
* You have logged in to the {product-title} web console.
14+
* You have installed the {coo-full}
15+
16+
.Procedure
17+
18+
. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
19+
. Choose the *UI Plugin* tab (at the far right of the tab list) and press *Create UIPlugin*
20+
. Select *YAML view*, enter the following content, and then press *Create*:
21+
+
22+
[source,yaml]
23+
----
24+
apiVersion: observability.openshift.io/v1alpha1
25+
kind: UIPlugin
26+
metadata:
27+
name: monitoring
28+
spec:
29+
type: Monitoring
30+
monitoring:
31+
incidents:
32+
enabled: true
33+
----

‎modules/coo-incident-detection-ui-plugin-using.adoc

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
3+
// * observability/cluster_observability_operator/ui_plugins/incident-detection-ui-plugin.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="coo-incident-detection-ui-plugin-using_{context}"]
7+
= Using the {coo-full} incident detection UI plugin
8+
9+
10+
.Prerequisites
11+
12+
* You have access to the cluster as a user with the `cluster-admin` cluster role.
13+
* You have logged in to the {product-title} web console.
14+
* You have installed the {coo-full}
15+
* You have installed the {coo-full} incident detection UI plugin.
16+
17+
.Procedure
18+
19+
TODO...

‎observability/cluster_observability_operator/ui_plugins/incident-detection-ui-plugin.adoc

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="incident-detection-ui-plugin"]
3+
= Incident-detection UI plugin
4+
include::_attributes/common-attributes.adoc[]
5+
:context: incident-detection-ui-plugin
6+
7+
toc::[]
8+
9+
:FeatureName: The {coo-full} incident detection UI plugin
10+
include::snippets/technology-preview.adoc[leveloffset=+2]
11+
12+
The incident detection UI plugin adds alert troubleshooting features to the Administrator perspective of the OpenShift web console at **Observe** → **Incidents**.
13+
14+
Incident detection groups alerts that occur around the same time 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 allows you to drill down into the individual alerts within an incident. The system also categorizes alerts by affected component, ranking them by importance. This helps you focus on the most critical areas first.
15+
16+
include::modules/coo-incident-detection-ui-plugin-install.adoc[leveloffset=+1]
17+
18+
include::modules/coo-incident-detection-ui-plugin-using.adoc[leveloffset=+1]

‎observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc

+11-1
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,14 @@ This results in a unified observability experience across different data sources
5757
5858
For more information, see the xref :../../../observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc#dashboard-ui-plugin[dashboard UI plugin] page.
5959
60-
////
60+
////
61+
62+
[id="incident-detection_{context}"]
63+
== Incident Detection
64+
65+
:FeatureName: The {coo-full} incident detection UI plugin
66+
include::snippets/technology-preview.adoc[leveloffset=+2]
67+
68+
The incident detection feature groups alerts that occur around the same time 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 allows you to drill down into the individual alerts within an incident. The system also categorizes alerts by affected component, ranking them by importance. This helps you focus on the most critical areas first.
69+
70+
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/incident-detection-ui-plugin.adoc#incident-detection-ui-plugin[incident-detection UI plugin] page.

0 commit comments

Comments
 (0)