Updated troubleshooting panel docs for COO 1.3 release.

Author: alanconway

images/coo-troubleshooting-panel-graph.png

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

images/coo-troubleshooting-panel-graph.svg

@@ -5,81 +5,48 @@
 :_mod-docs-content-type: PROCEDURE
 [id="coo-troubleshooting-ui-plugin-using_{context}"]
 = Using the {coo-full} troubleshooting UI plugin
-
-include::snippets/unified-perspective-web-console.adoc[]
+include::_attributes/common-attributes.adoc[]
+:icons: font
 
 .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 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 when the following Red Hat provided components are be installed in the installer-recommended namespace.
 
-* **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)
+* **Logs:** `{ocp-product-title} Logging` (collection) and `{ocp-product-title} Loki Operator` (store)
+* **Network events:**` {ocp-product-title} Network observability` (collection) and  `{ocp-product-title} Loki Operator` (store)
+* **Traces:** `{ocp-product-title} Distributed Tracing` (collection and store)
 ====
-.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.
-+
-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 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.
-+
 [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.
+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.
 ====
-+
-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.
+.Procedure
+The **Troubleshooting Panel** is a side-panel that shows a graph of resources and signals related to the information displayed in the main console.
+You can use the troubleshooting panel on most console pages - resources, alerts, metrics, logs, traces, network observability and more.
 
-.. **Show Query:** Clicking this button enables some experimental features:
+. Open the Application Launcher {launch}, click the **Signal Correlation** menu item.
 +
-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.
+image::coo-troubleshooting-panel-link.png[Open panel]
 +
-[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.
-
-**** `log:__LOG_TYPE__` representing stored logs, where `__LOG_TYPE__` must be one of `application`, `infrastructure` or `audit`.
+. Click **Focus** to show a correlation graph starting from the resources or signals in the main console display.
++
+image::coo-troubleshooting-panel-graph.png[Troubleshooting panel]
++
+<1> **Focus** will re-calculate the graph from the main console at any time.
+<2> **Sync** refreshes the graph that is currently displayed.
+<3> The root node represents the resource in the main console window.
+<4> "First degree" neighbors - directly related to the initial resource.
+<5> "Second degree" neighbors - indirectly related via first-degree neighbors.
++
+. Clicking on a node opens the data in the main console.
++
+image::coo-troubleshooting-panel-log.png[Troubleshooting panel]