Skip to content

Commit

Permalink
OBSDOCS-1294 Observability UI plugins overview
Browse files Browse the repository at this point in the history
  • Loading branch information
gabriel-rh committed Sep 4, 2024
1 parent 6692ffb commit 2ab0641
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 0 deletions.
6 changes: 6 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3035,6 +3035,12 @@ Topics:
File: installing-the-cluster-observability-operator
- Name: Configuring the Cluster Observability Operator to monitor a service
File: configuring-the-cluster-observability-operator-to-monitor-a-service
- Name: Observability UI plugins
Dir: ui_plugins
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Observability UI plugins overview
File: observability-ui-plugins-overview
---
Name: Scalability and performance
Dir: scalability_and_performance
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:_mod-docs-content-type: ASSEMBLY
[id="observability-ui-plugins-overview"]
= Observability UI plugins overview
include::_attributes/common-attributes.adoc[]
:context: observability-ui-plugins-overview

toc::[]

:FeatureName: The Cluster Observability Operator
include::snippets/technology-preview.adoc[leveloffset=+2]


The {coo-first} can install and manage UI plugins to enhance the observability capabilities of the OpenShift web console. The plugins extend the default functionality, providing new UI features for monitoring, troubleshooting, distributed tracing, and cluster logging.

== Dashboards

The dashboard UI plugin supports enhanced dashboards in the OpenShift web console at *Observe* -> *Dashboards* . You can add other Prometheus datasources from the cluster to the default dashboards, in addition to the in-cluster datasource. This results in a unified observability experience across different data sources.

== Troubleshooting

The troubleshooting panel UI plugin provides observability signal correlation, powered by the open source Korrel8r project. With the troubleshooting panel available under *Observe* -> *Alerting* , you can easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores.
The output of Korrel8r is displayed in the form of an interactive node graph. When you click on a node, you are automatically redirected to the corresponding web console page with the specific information for that node, for example, metric, log, pod, etc.

== Distributed tracing

The distributed tracing UI plugin adds tracing-related features to the OpenShift web console under *Observe* -> *Traces*. You can follow requests through the front end and into the backend of microservices, helping you identify code errors and performance bottlenecks in distributed systems. Select a supported Tempo insance running the cluster, and set a time range and query, to view the trace data.

== CLuster logging

The logging UI plugin surfaces logging data in the OpenShift web console under *Observe* -> *Logs*. You can specify filters, queries, time ranges and refresh rates, with the results displayed a list of collapsed logs, which can then be expanded to show more detailed information for each log.

0 comments on commit 2ab0641

Please sign in to comment.