[standalone-coo-docs-1-latest] OBSDOCS-2695: [COO] Update signal correlation panel for COO 1.3 release.

_attributes/common-attributes.adoc

@@ -38,6 +38,9 @@
 :cmo-full: Cluster Monitoring Operator
 :cmo-short: CMO
 
+// Observability Signal Correlation
+:korrel8r: https://github.com/korrel8r/korrel8r[Korrel8r]
+:sync: image:fa-sync-alt.svg[Sync,20]
 
 // Cluster Observability Operator
 :coo-first: Cluster Observability Operator (COO)

modules/coo-troubleshooting-ui-plugin-advanced.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+
+// * observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="coo-troubleshooting-ui-plugin-advanced_{context}"]
+= Advanced controls for the {coo-full} troubleshooting panel UI plugin
+
+The **Advanced** button opens additional controls over the correlation search.
+These are *experimental* and might change in a future release.
+They provide access to additional features of the {korrel8r} upstream project that powers the correlation search.
+
+image::coo-troubleshooting-panel-advanced.png[Advanced Controls]
+
+
+The following list explains the additional controls under the *Advanced* button:
+
+* **Recent** The search is limited to recent results, by default in the last day.
+* **Range** Allows searching an explicit date/time range in the past.
+* **Distance** Searches up to the given distance from the starting point.
+    Each correlation rule (edge in the graph) is a "step", and the **distance** is the maximum number of steps.
+* **Goal Class** Instead of a distance, you can select a **goal**, which is a resource or signal type.
+    This searches for paths from the start to the goal type, and the path length is not limited.
+    For more information about correlation classes, see the {korrel8r} project documentation.
+* **Query** The {korrel8r} query representing the starting point for the search.
+    Click **Focus** to reset the query to reflect the current console page.
+    Click **Sync** to re-run the current query and update the graph.
+    For more information about correlation queries, see the {korrel8r} project documentation.
+

modules/coo-troubleshooting-ui-plugin-install.adoc

@@ -24,4 +24,5 @@ metadata:
   name: troubleshooting-panel
 spec:
   type: TroubleshootingPanel
-----
+----
+

modules/coo-troubleshooting-ui-plugin-using.adoc

@@ -4,82 +4,53 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="coo-troubleshooting-ui-plugin-using_{context}"]
-= Using the {coo-full} troubleshooting UI plugin
+= Using the {coo-full} troubleshooting panel UI plugin
+:icons: font
 
-include::snippets/unified-perspective-web-console.adoc[]
+The **Troubleshooting Panel** is a side-panel that shows a graph of resources and signals related to the information displayed in the main console (in this example the `apiserver` Deployment).
+You can use the troubleshooting panel on most console pages such as resources, alerts, metrics, logs, traces, network observability and others.
 
 .Prerequisites
-* You have access to the {ocp-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 access to the {ocp-product-title} cluster as a user with the `cluster-admin` cluster role.
 * You have logged in to the {ocp-product-title} web console.
-* You have installed {ocp-product-title} Logging, if you want to visualize correlated logs.
-* You have installed {ocp-product-title} Network Observability, if you want to visualize correlated netflows.
 * You have installed the {coo-full}.
 * You have installed the {coo-full} troubleshooting UI plugin.
-+
+
 [NOTE]
 ====
-The troubleshooting panel relies on the observability signal stores installed in your cluster.
-Kuberenetes resources, alerts and metrics are always available by default in an {ocp-product-title} cluster.
-Other signal types require optional components to be installed:
+The troubleshooting panel can display additional signals if you have installed the following Red{nbsp}Hat components in their recommended namespace:
+
+* **Logs:**
+** `{ocp-product-title} Logging` (collection)
+** `{ocp-product-title} Loki Operator` (store)
+* **Network events:**
+** `{ocp-product-title} Network observability` (collection)
+** `{ocp-product-title} Loki Operator` (store)
+* **Traces:** `{ocp-product-title} Distributed Tracing` (collection and store)
+====
 
-* **Logs:** Red Hat Openshift Logging (collection) and Loki Operator provided by Red Hat (store)
-* **Network events:** Network observability provided by Red Hat (collection) and Loki Operator provided by Red Hat (store)
+[NOTE]
+====
+Users with `ClusterRole/view` (for example `kube:admin`) will get the most complete results.
+Other users will see more restricted graphs, showing only data that they have permission to see.
 ====
-.Procedure
 
-. In 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.
+.Procedure
+. Open the Application Launcher {launch} and click the **Signal Correlation** menu item.
 +
-image::coo-troubleshooting-panel-link.png[Troubleshooting Panel link]
+image::coo-troubleshooting-panel-link.png[Open panel]
 +
-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 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.
+. Click **Focus** to show a correlation graph starting from the resources or signals in the main console display. This example shows the `apiserver` Deployment.
 +
-[NOTE]
-====
-Clicking on a node may sometimes show fewer results than indicated on the graph. This is a known issue that will be addressed in a future release.
-====
+image::coo-troubleshooting-panel-graph.png[Troubleshooting Panel]
 +
-image::coo-troubleshooting-panel-graph.png[Troubleshooting panel]
-[arabic]
-.. **Alert (1):** This node is the starting point in the graph and represents the `KubeContainerWaiting` alert displayed in the web console.
-
-.. **Pod (1):** This node indicates that there is a single `Pod` resource associated with this alert. Clicking on this node will open a console search showing the related pod directly.
-
-.. **Event (2):** There are two Kuberenetes events associated with the pod. Click this node to see the events.
-
-.. **Logs (74):** This pod has 74 lines of logs, which you can access by clicking on this node.
-
-.. **Metrics (105):** There are many metrics associated with the pod.
-
-.. **Network (6):** There are network events, meaning the pod has communicated over the network. The remaining nodes in the graph represent the `Service`, `Deployment` and `DaemonSet` resources that the pod has communicated with.
-
-.. **Focus:** Clicking this button updates the graph. By default, the graph itself does not change when you click on nodes in the graph. Instead, the main web console page changes, and you can then navigate to other resources using links on the page, while the troubleshooting panel itself stays open and unchanged. To force an update to the graph in the troubleshooting panel, click **Focus**. This draws a new graph, using the current resource in the web console as the starting point.
-
-.. **Show Query:** Clicking this button enables some experimental features:
+.. Click **Focus** to re-calculate the graph from the main console at any time.
+.. Click {sync} to refresh the graph that is currently displayed.
+.. The root (top) node represents the resource in the main console window.
+.. First-degree neighbors are directly related to the initial resource.
+.. Second-degree neighbors are indirectly related via first-degree neighbors.
 +
-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.
-
-... **Neighbourhood depth** is used to display a smaller or larger neighbourhood.
+. Clicking on a node opens the data in the main console. For example if you click on the Log node, the following panel appears:
 +
-[NOTE]
-====
-Setting a large value in a large cluster might cause the query to fail, if the number of results is too big.
-====
-... **Goal class** results in a goal directed search instead of a neighbourhood search. A goal directed search shows all paths from the starting point to the goal class, which indicates a type of resource or signal. The format of the goal class is experimental and may change. Currently, the following goals are valid:
-**** `k8s:__RESOURCE[VERSION.[GROUP]]__` identifying a kind of kuberenetes resource. For example `k8s:Pod` or `k8s:Deployment.apps.v1`.
-**** `alert:alert` representing any alert.
-
-**** `metric:metric` representing any metric.
-
-**** `netflow:network` representing any network observability network event.
+image::coo-troubleshooting-panel-log.png[Viewing Logs]
 
-**** `log:__LOG_TYPE__` representing stored logs, where `__LOG_TYPE__` must be one of `application`, `infrastructure` or `audit`.

ui_plugins/troubleshooting-ui-plugin.adoc

@@ -1,26 +1,22 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="troubleshooting-ui-plugin"]
-= Troubleshooting UI plugin
+= Troubleshooting panel UI plugin
 include::_attributes/common-attributes.adoc[]
 :context: troubleshooting-ui-plugin
 
 toc::[]
 
-:FeatureName: The {coo-full} troubleshooting panel UI plugin
-include::snippets/technology-preview.adoc[leveloffset=+2]
+The troubleshooting panel UI plugin provides observability signal correlation.
+With the troubleshooting panel, which is available from the Application Launcher {launch},
+you can easily navigate to resources, metrics, logs, alerts, netflows, and other observability signals
+that are correlated to the current contents of the console screen.
 
-The troubleshooting UI plugin for {ocp-product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project.
-With the troubleshooting panel that is available under *Observe* -> *Alerting*, you can easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores.
-Users of {ocp-product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}.
-
-When you install the troubleshooting UI plugin, a link:https://github.com/korrel8r/korrel8r[Korrel8r] service named `korrel8r` is deployed in the same namespace, and it is able to locate related observability signals and Kubernetes resources from its correlation engine.
-
-The output of Korrel8r is displayed in the form of an interactive node graph in the {ocp-product-title} web console.
+The panel displays an interactive node graph in the {ocp-product-title} web console.
 Nodes in the graph represent a type of resource or signal, while edges represent relationships.
-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.
+When you click on a node, you are automatically redirected to the corresponding web console page.
 
 include::modules/coo-troubleshooting-ui-plugin-install.adoc[leveloffset=+1]
 
 include::modules/coo-troubleshooting-ui-plugin-using.adoc[leveloffset=+1]
 
-include::modules/coo-troubleshooting-ui-plugin-creating-alert.adoc[leveloffset=+1]
+include::modules/coo-troubleshooting-ui-plugin-advanced.adoc[leveloffset=+2]