From 3365a6cb4e306bab223aeeb56ff31d77852144c8 Mon Sep 17 00:00:00 2001
From: Gabriel McGoldrick <gmcgoldr@redhat.com>
Date: Fri, 6 Sep 2024 13:43:26 +0100
Subject: [PATCH] OBSDOCS-1242 Distributed tracing UI plugin

---
 _topic_maps/_topic_map.yml                    |  2 ++
 ...distributed-tracing-ui-plugin-install.adoc | 30 +++++++++++++++++++
 ...o-distributed-tracing-ui-plugin-using.adoc | 27 +++++++++++++++++
 .../distributed-tracing-ui-plugin.adoc        | 16 ++++++++++
 4 files changed, 75 insertions(+)
 create mode 100644 modules/coo-distributed-tracing-ui-plugin-install.adoc
 create mode 100644 modules/coo-distributed-tracing-ui-plugin-using.adoc
 create mode 100644 observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc

diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
index 925a3ae4af59..a991153ceb25 100644
--- a/_topic_maps/_topic_map.yml
+++ b/_topic_maps/_topic_map.yml
@@ -2811,6 +2811,8 @@ Topics:
       File: observability-ui-plugins-overview
     - Name: Dashboard UI plugin
       File: dashboard-ui-plugin
+    - Name: Distributed tracing UI plugin
+      File: distributed-tracing-ui-plugin
 ---
 Name: Scalability and performance
 Dir: scalability_and_performance
diff --git a/modules/coo-distributed-tracing-ui-plugin-install.adoc b/modules/coo-distributed-tracing-ui-plugin-install.adoc
new file mode 100644
index 000000000000..1009d113ed46
--- /dev/null
+++ b/modules/coo-distributed-tracing-ui-plugin-install.adoc
@@ -0,0 +1,30 @@
+// Module included in the following assemblies:
+
+// * observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="coo-distributed-tracing-ui-plugin-install-_{context}"]
+= Installing the {coo-full} distributed tracing UI plugin
+
+
+.Prerequisites
+
+* You have access to the cluster as a user with the `cluster-admin` cluster role.
+* You have logged in to the {product-title} web console.
+* You have installed the {coo-full}
+
+.Procedure
+
+. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
+. Choose the *UI Plugin* tab (at the far right of the tab list) and press *Create UIPlugin*
+. Select *YAML view*, enter the following content, and then press *Create*:
++
+[source,yaml]
+----
+apiVersion: observability.openshift.io/v1alpha1
+kind: UIPlugin
+metadata:
+  name: distributed-tracing
+spec:
+  type: DistributedTracing
+----
\ No newline at end of file
diff --git a/modules/coo-distributed-tracing-ui-plugin-using.adoc b/modules/coo-distributed-tracing-ui-plugin-using.adoc
new file mode 100644
index 000000000000..2a7e3b982220
--- /dev/null
+++ b/modules/coo-distributed-tracing-ui-plugin-using.adoc
@@ -0,0 +1,27 @@
+// Module included in the following assemblies:
+
+// * observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="coo-distributed-tracing-ui-plugin-using_{context}"]
+= Using the {coo-full} distributed tracing UI plugin
+
+.Prerequisites
+
+* You have access to the cluster as a user with the `cluster-admin` cluster role.
+* You have logged in to the {product-title} web console.
+* You have installed the {coo-full}.
+* You have installed the {coo-full} distributed tracing UI plugin.
+* You have a `TempoStack` or `TempoMonolithic` multi-tenant instance in the cluster.
+
+.Procedure
+
+. In the Administrator perspective of 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`. 
+. 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.
+
+
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
new file mode 100644
index 000000000000..f9804102e5f2
--- /dev/null
+++ b/observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc
@@ -0,0 +1,16 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="distributed-tracing-ui-plugin"]
+= Distributed tracing UI plugin
+include::_attributes/common-attributes.adoc[]
+:context: distributed-tracing-ui-plugin
+
+toc::[]
+
+:FeatureName: The Cluster Observability Operator
+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. 
+
+include::modules/coo-distributed-tracing-ui-plugin-install.adoc[leveloffset=+1]
+
+include::modules/coo-distributed-tracing-ui-plugin-using.adoc[leveloffset=+1]