mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OBSDOCS-1980 add note on developer perspective in 4.19+
This commit is contained in:
Gabriel McGoldrick
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
d02cabf4ca
commit
5d1f833bec
@@ -16,10 +16,10 @@
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the Administrator perspective of the {product-title} web console, click **Observe** → **Traces**.
|
||||
. In the {product-title} web console, click **Observe** → **Traces**.
|
||||
. Select a `TempoStack` or `TempoMonolithic` multi-tenant instance and set a time range and query for the traces to be loaded.
|
||||
+
|
||||
The traces are displayed on a scatter-plot showing the trace start time, duration, and number of spans. Underneath the scatter plot, there is a list of traces showing information such as the `Trace Name`, number of `Spans`, and `Duration`.
|
||||
The traces are displayed on a scatter-plot showing the trace start time, duration, and number of spans. Underneath the scatter plot, there is a list of traces showing information such as the `Trace Name`, number of `Spans`, and `Duration`.
|
||||
. Click on a trace name link.
|
||||
+
|
||||
The trace detail page for the selected trace contains a Gantt Chart of all of the spans within the trace. Select a span to show a breakdown of the configured attributes.
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
[id="coo-troubleshooting-ui-plugin-using_{context}"]
|
||||
= Using the {coo-full} troubleshooting UI plugin
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
.Prerequisites
|
||||
* You have access to the {product-title} cluster as a user with the `cluster-admin` cluster role. If your cluster version is 4.17+, you can access the troubleshooting UI panel from the Application Launcher {launch}.
|
||||
* You have logged in to the {product-title} web console.
|
||||
@@ -25,12 +27,12 @@ Other signal types require optional components to be installed:
|
||||
====
|
||||
.Procedure
|
||||
|
||||
. In the admin perspective of the web console, navigate to *Observe* -> *Alerting* and then select an alert. If the alert has correlated items, a **Troubleshooting Panel** link will appear above the chart on the alert detail page.
|
||||
. In the the web console, go to *Observe* -> *Alerting* and then select an alert. If the alert has correlated items, a **Troubleshooting Panel** link will appear above the chart on the alert detail page.
|
||||
+
|
||||
image::coo-troubleshooting-panel-link.png[Troubleshooting Panel link]
|
||||
+
|
||||
Click on the **Troubleshooting Panel** link to display the panel.
|
||||
. The panel consists of query details and a topology graph of the query results. The selected alert is converted into a Korrel8r query string and sent to the `korrel8r` service.
|
||||
. The panel consists of query details and a topology graph of the query results. The selected alert is converted into a Korrel8r query string and sent to the `korrel8r` service.
|
||||
The results are displayed as a graph network connecting the returned signals and resources. This is a _neighbourhood_ graph, starting at the current resource and including related objects up to 3 steps away from the starting point.
|
||||
Clicking on nodes in the graph takes you to the corresponding web console pages for those resouces.
|
||||
. You can use the troubleshooting panel to find resources relating to the chosen alert.
|
||||
@@ -62,11 +64,11 @@ image::coo-troubleshooting-experimental.png[Experimental features]
|
||||
[arabic]
|
||||
... **Hide Query** hides the experimental features.
|
||||
|
||||
... The query that identifies the starting point for the graph.
|
||||
The query language, part of the link:https://korrel8r.github.io/korrel8r[Korrel8r] correlation engine used to create the graphs, is experimental and may change in future.
|
||||
The query is updated by the **Focus** button to correspond to the resources in the main web console window.
|
||||
... The query that identifies the starting point for the graph.
|
||||
The query language, part of the link:https://korrel8r.github.io/korrel8r[Korrel8r] correlation engine used to create the graphs, is experimental and may change in future.
|
||||
The query is updated by the **Focus** button to correspond to the resources in the main web console window.
|
||||
|
||||
... **Neighbourhood depth** is used to display a smaller or larger neighbourhood.
|
||||
... **Neighbourhood depth** is used to display a smaller or larger neighbourhood.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
|
||||
@@ -24,6 +24,8 @@ The following table provides information about which features are available depe
|
||||
| 1.2+ | 4.19+ | ✔ | ✔ | ✔ | ✔ | ✔
|
||||
|===
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-2-2_{context}"]
|
||||
== {coo-full} 1.2.2
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
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 dashboard UI plugin supports enhanced dashboards in the {product-title} 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'`.
|
||||
The plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`.
|
||||
|
||||
include::modules/coo-dashboard-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -6,7 +6,9 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
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.
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
The distributed tracing UI plugin adds tracing-related features to the {product-title} 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.
|
||||
|
||||
include::modules/coo-distributed-tracing-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -6,16 +6,18 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
The logging UI plugin surfaces logging data in the {product-title} web console on the *Observe* -> *Logs* page.
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
The logging UI plugin surfaces logging data in the {product-title} web console on the *Observe* -> *Logs* page.
|
||||
You can specify filters, queries, time ranges and refresh rates, with the results displayed as a list of collapsed logs, which can then be expanded to show more detailed information for each log.
|
||||
|
||||
When you have also deployed the Troubleshooting UI plugin on {product-title} version 4.16+, it connects to the Korrel8r service and adds direct links from the Administration perspective, from the **Observe** -> **Logs** page, to the **Observe** -> **Metrics** page with a correlated PromQL query. It also adds a **See Related Logs** link from the Administration perspective alerting detail page, at **Observe** -> **Alerting**, to the **Observe** -> **Logs** page with a correlated filter set selected.
|
||||
If you also deploy the Troubleshooting UI plugin on {product-title} version 4.16+, it connects to the Korrel8r service and adds direct links to the web console, from the **Observe** -> **Logs** page, to the **Observe** -> **Metrics** page with a correlated PromQL query. The plugin also adds a **See Related Logs** link from the web console alerting detail page, at **Observe** -> **Alerting**, to the **Observe** -> **Logs** page with a correlated filter set selected.
|
||||
|
||||
The features of the plugin are categorized as:
|
||||
|
||||
dev-console:: Adds the logging view to the Developer perspective.
|
||||
dev-console:: Adds the logging view to the web console.
|
||||
alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view.
|
||||
dev-alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view for the Developer perspective.
|
||||
dev-alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view for the web console.
|
||||
|
||||
|
||||
For {coo-first} versions, the support for these features in {product-title} versions is shown in the following table:
|
||||
|
||||
@@ -9,13 +9,15 @@ toc::[]
|
||||
:FeatureName: The {coo-full} monitoring UI plugin
|
||||
include::snippets/technology-preview.adoc[leveloffset=+2]
|
||||
|
||||
The monitoring UI plugin adds monitoring features to the Administrator perspective of the OpenShift web console.
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
The monitoring UI plugin adds monitoring features to the {product-title} web console.
|
||||
|
||||
* **{rh-rhacm}:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing {rh-rhacm} with the same alerting capabilities as {product-title}. You can configure the plugin to fetch alerts from the {rh-rhacm} Alertmanager backend. This enables seamless integration and user experience by aligning {rh-rhacm} and {product-title} monitoring workflows.
|
||||
|
||||
* **Incident detection:** The incident detection feature groups related alerts 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 you can drill down into the individual alerts within an incident. The system also categorizes alerts by affected component, grouped by severity. This helps you focus on the most critical areas first.
|
||||
+
|
||||
The incident detection feature is available in the Administrator perspective of the OpenShift web console at **Observe** → **Incidents**.
|
||||
The incident detection feature is available in the {product-title} web console at **Observe** → **Incidents**.
|
||||
|
||||
include::modules/coo-monitoring-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The plugins extend the default functionality, providing new UI features for trou
|
||||
[id="monitoring_{context}"]
|
||||
== Monitoring
|
||||
|
||||
The monitoring UI plugin adds monitoring related UI features to the OpenShift web console, for the Advance Cluster Management (ACM) perspective and for incident detection.
|
||||
The monitoring UI plugin adds monitoring related UI features to the {product-title} web console, for the Advance Cluster Management (ACM) perspective and for incident detection.
|
||||
|
||||
* **ACM:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing ACM with the same monitoring capabilities as {product-title}.
|
||||
|
||||
@@ -23,7 +23,7 @@ For more information, see the xref:../../../observability/cluster_observability_
|
||||
[id="cluster-logging_{context}"]
|
||||
== Cluster logging
|
||||
|
||||
The logging UI plugin surfaces logging data in the web console on the *Observe* -> *Logs* page.
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user