diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 4a9ce7ce265e..368643841a55 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2976,14 +2976,14 @@ Topics: Topics: - Name: Observability UI plugins overview File: observability-ui-plugins-overview - - Name: Dashboard UI plugin - File: dashboard-ui-plugin + - Name: Logging UI plugin + File: logging-ui-plugin - Name: Distributed tracing UI plugin File: distributed-tracing-ui-plugin - Name: Troubleshooting UI plugin File: troubleshooting-ui-plugin - - Name: Logging UI plugin - File: logging-ui-plugin +# - Name: Dashboard UI plugin +# File: dashboard-ui-plugin --- Name: Scalability and performance Dir: scalability_and_performance diff --git a/observability/cluster_observability_operator/cluster-observability-operator-overview.adoc b/observability/cluster_observability_operator/cluster-observability-operator-overview.adoc index 5fa4d3f062fa..4715e2dc49ff 100644 --- a/observability/cluster_observability_operator/cluster-observability-operator-overview.adoc +++ b/observability/cluster_observability_operator/cluster-observability-operator-overview.adoc @@ -6,8 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The Cluster Observability Operator -include::snippets/technology-preview.adoc[leveloffset=+2] The {coo-first} is an optional component of the {product-title} designed for creating and managing highly customizable monitoring stacks. It enables cluster administrators to automate configuration and management of monitoring needs extensively, offering a more tailored and detailed view of each namespace compared to the default {product-title} monitoring system. diff --git a/observability/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service.adoc b/observability/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service.adoc index a1683f75824b..d7751c3586bb 100644 --- a/observability/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service.adoc +++ b/observability/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The Cluster Observability Operator -include::snippets/technology-preview.adoc[leveloffset=+2] - You can monitor metrics for a service by configuring monitoring stacks managed by the {coo-first}. To test monitoring a service, follow these steps: diff --git a/observability/cluster_observability_operator/installing-the-cluster-observability-operator.adoc b/observability/cluster_observability_operator/installing-the-cluster-observability-operator.adoc index 51fcae69e440..1aab682cec82 100644 --- a/observability/cluster_observability_operator/installing-the-cluster-observability-operator.adoc +++ b/observability/cluster_observability_operator/installing-the-cluster-observability-operator.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The Cluster Observability Operator -include::snippets/technology-preview.adoc[leveloffset=+2] - As a cluster administrator, you can install or remove the {coo-first} from OperatorHub by using the {product-title} web console. OperatorHub is a user interface that works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster. diff --git a/observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc b/observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc index 68fc00d8d947..6a6144982867 100644 --- a/observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc +++ b/observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The Cluster Observability Operator -include::snippets/technology-preview.adoc[leveloffset=+2] - 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. The plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`. diff --git a/observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc b/observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc index f9804102e5f2..dd57008021ad 100644 --- a/observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc +++ b/observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The Cluster Observability Operator +:FeatureName: The {coo-full} distributed tracing UI plugin include::snippets/technology-preview.adoc[leveloffset=+2] The distributed tracing UI plugin adds tracing-related features to the Administrator perspective of the OpenShift web console at **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. diff --git a/observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc b/observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc index 706cc34cdf6c..dadd25a44763 100644 --- a/observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc +++ b/observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc @@ -6,24 +6,26 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The {coo-full} -include::snippets/technology-preview.adoc[leveloffset=+2] - You can use the {coo-first} to install and manage UI plugins to enhance the observability capabilities of the {product-title} web console. -The plugins extend the default functionality, providing new UI features for monitoring, troubleshooting, distributed tracing, and cluster logging. +The plugins extend the default functionality, providing new UI features for troubleshooting, distributed tracing, and cluster logging. -[id="dashboards_{context}"] -== Dashboards -The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards*. -You can add other Prometheus data sources from the cluster to the default dashboards, in addition to the in-cluster data source. -This results in a unified observability experience across different data sources. -For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc#dashboard-ui-plugin[dashboard UI plugin] page. +[id="cluster-logging_{context}"] +== Cluster logging + +The logging UI plugin surfaces logging data in the web console on the *Observe* -> *Logs* page. +You can specify filters, queries, time ranges and refresh rates. The results displayed a list of collapsed logs, which can then be expanded to show more detailed information for each log. + +For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[logging UI plugin] page. + [id="troubleshooting_{context}"] == Troubleshooting +:FeatureName: The {coo-full} troubleshooting panel UI plugin +include::snippets/technology-preview.adoc[leveloffset=+2] + The troubleshooting panel UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project. You can use the troubleshooting panel available from the *Observe* -> *Alerting* page to easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores. Users of {product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}. @@ -35,6 +37,9 @@ For more information, see the xref:../../../observability/cluster_observability_ [id="distributed-tracing_{context}"] == Distributed tracing +:FeatureName: The {coo-full} distributed tracing UI plugin +include::snippets/technology-preview.adoc[leveloffset=+2] + The distributed tracing UI plugin adds tracing-related features to the web console on the *Observe* -> *Traces* page. 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. You can select a supported `TempoStack` or `TempoMonolithic` multi-tenant instance running in the cluster and set a time range and query to view the trace data. @@ -42,10 +47,14 @@ You can select a supported `TempoStack` or `TempoMonolithic` multi-tenant instan For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[distributed tracing UI plugin] page. -[id="cluster-logging_{context}"] -== Cluster logging +//// +[id="dashboards_{context}"] +== Dashboards -The logging UI plugin surfaces logging data in the web console on the *Observe* -> *Logs* page. -You can specify filters, queries, time ranges and refresh rates. The results displayed a list of collapsed logs, which can then be expanded to show more detailed information for each log. +The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards*. +You can add other Prometheus data sources from the cluster to the default dashboards, in addition to the in-cluster data source. +This results in a unified observability experience across different data sources. -For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[logging UI plugin] page. +For more information, see the xref :../../../observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc#dashboard-ui-plugin[dashboard UI plugin] page. + +//// \ No newline at end of file diff --git a/observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc b/observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc index 7905602a4acc..12706dbc78a7 100644 --- a/observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc +++ b/observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: The Cluster Observability Operator +:FeatureName: The {coo-full} troubleshooting panel UI plugin include::snippets/technology-preview.adoc[leveloffset=+2] The troubleshooting UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project.