-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OBSDOCS-1294 Observability UI plugins overview
- Loading branch information
1 parent
6692ffb
commit 2ab0641
Showing
6 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
observability/cluster_observability_operator/ui_plugins/_attributes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../_attributes/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../images/ |
1 change: 1 addition & 0 deletions
1
observability/cluster_observability_operator/ui_plugins/modules
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../modules/ |
31 changes: 31 additions & 0 deletions
31
...luster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
1 change: 1 addition & 0 deletions
1
observability/cluster_observability_operator/ui_plugins/snippets
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../snippets/ |