UI plugins for Red Hat OpenShift Cluster Observability Operator

Procedure

1. In the OpenShift Container Platform web console, click Operators → Installed Operators and select Cluster Observability Operator
2. Choose the UI Plugin tab (at the far right of the tab list) and press Create UIPlugin

3. Select YAML view, enter the following content, and then press Create:

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: monitoring
   spec:
     type: Monitoring
     monitoring:
       acm: 

   1

   
         enabled: true
         alertmanager:
           url: 'https://alertmanager.open-cluster-management-observability.svc:9095'
         thanosQuerier:
           url: 'https://rbac-query-proxy.open-cluster-management-observability.svc:8443'
       incidents: 

   2

   
         enabled: true

   Copy to Clipboard Toggle word wrap

   1

   Enable RHACM features. You must configure the Alertmanager and ThanosQuerier Service endpoints.

   2

   Enable incident detection features.

Procedure

1. In the Administrator perspective of the web console, click on Observe → Alerting and choose the Incidents tab.

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

   

   View larger image

   
   Note

   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.

   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.

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

   

   View larger image

   
   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.

4. By clicking on an incident, you can see the timeline of alerts that are part of that incident, in the Alerts Timeline UI.

   

   View larger image

   

5. In the list of alerts that follows, alerts are mapped to specific components, which are grouped by severity.

   

   View larger image

   

6. Click to expand a component in the list. The underlying alerts related to that component are displayed.

   

   View larger image

   
7. Click the link for an alert, to see detailed information about the associated alert rule.

Procedure

1. In the OpenShift Container Platform web console, click Operators → Installed Operators and select Cluster Observability Operator.
2. Choose the UI Plugin tab (at the far right of the tab list) and click Create UIPlugin.

3. Select YAML view, enter the following content, and then click Create:

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: logging
   spec:
     type: Logging
     logging:
       lokiStack:
         name: logging-loki
       logsLimit: 50
       timeout: 30s
       schema: otel 

   1

   Copy to Clipboard Toggle word wrap

   1

   schema is one of otel, viaq, or select. The default is viaq if no value is specified. When you choose select, you can select the mode in the UI when you run a query.

   Note

   These are the known issues for the logging UI plugin - for more information, see OU-587.

   • The schema feature is only supported in OpenShift Container Platform 4.15 and later. In earlier versions of Red Hat OpenShift Cluster Observability Operator, the logging UI plugin will only use the viaq attribute, ignoring any other values that might be set.
   • Non-administrator users cannot query logs using the otel attribute with logging for Red Hat OpenShift versions 5.8 to 6.2. This issue will be fixed in a future logging release. (LOG-6589)
   • In logging for Red Hat OpenShift version 5.9, the severity_text Otel attribute is not set.

Procedure

1. In the OpenShift Container Platform web console, click Operators → Installed Operators and select Cluster Observability Operator
2. Choose the UI Plugin tab (at the far right of the tab list) and press Create UIPlugin

3. Select YAML view, enter the following content, and then press Create:

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: distributed-tracing
   spec:
     type: DistributedTracing

   Copy to Clipboard Toggle word wrap

Procedure

1. In the OpenShift Container Platform web console, click Observe → Traces.
2. Select a Tempo instance. If selecting a multi-tenant instance, also select a tenant.
3. Select a Time range and Limit traces.

4. Use the two Filter drop-down menus to filter by an attribute:

   • Service Name
   • Span Name
   • Namespace
   • Status
   • Span Duration
   • Trace Duration

   • Custom attributes

     Tip

     For more advanced filtering, click the Show query link and edit the TraceQL query.

     As a result of your filter selections, a scatter plot visualizes traces with trace start time, duration, and number of spans.

     Also, the traces are listed under the scatter plot, including trace details such as the Trace Name, number of Spans, and Duration.

     The back end searches both the object storage and ingester caches in parallel until the requested number of traces is found. The search results are a random and unordered sample of traces matching the search parameters.

5. Select a trace to view a Gantt chart of its spans.
6. In the Gantt chart, select a span to view its configured attributes.

Procedure

1. In the OpenShift Container Platform web console, click Operators → Installed Operators and select Cluster Observability Operator
2. Choose the UI Plugin tab (at the far right of the tab list) and press Create UIPlugin

3. Select YAML view, enter the following content, and then press Create:

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: troubleshooting-panel
   spec:
     type: TroubleshootingPanel

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the Application Launcher and click the Signal Correlation menu item.

   

   View larger image

   

2. Click Focus to show a correlation graph starting from the resources or signals in the main console display. This example shows the apiserver Deployment.

   

   View larger image

   
   1. Click Focus to re-calculate the graph from the main console at any time.
   2. Click the refresh icon to update the graph that is currently displayed.
   3. The root (top) node represents the resource in the main console window.
   4. First-degree neighbors are directly related to the initial resource.
   5. Second-degree neighbors are indirectly related via first-degree neighbors.

3. Clicking on a node opens the data in the main console. For example if you click on the Log node, the following panel appears:

   

   View larger image