Merge pull request #86125 from openshift-cherrypick-robot/cherry-pick-84482-to-enterprise-4.16

[enterprise-4.16] OBSDOCS-1412: Add must-gather docs for Tempo and OpenTelemetry

Author: lahinson

_topic_maps/_topic_map.yml

@@ -2928,6 +2928,8 @@ Topics:
       File: distr-tracing-tempo-installing
     - Name: Configuring
       File: distr-tracing-tempo-configuring
+    - Name: Troubleshooting
+      File: distr-tracing-tempo-troubleshooting
     - Name: Upgrading
       File: distr-tracing-tempo-updating
     - Name: Removing

modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc

@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="distr-tracing-tempo-collecting-diagnostic-data-from-command-line_{context}"]
+= Collecting diagnostic data from the command line
+
+When submitting a support case, it is helpful to include diagnostic information about your cluster to Red Hat Support.
+You can use the `oc adm must-gather` tool to gather diagnostic data for resources of various types, such as `TempoStack` or `TempoMonolithic`, and the created resources like `Deployment`, `Pod`, or `ConfigMap`.
+The `oc adm must-gather` tool creates a new pod that collects this data.
+
+.Procedure
+
+* From the directory where you want to save the collected data, run the `oc adm must-gather` command to collect the data:
++
+[source,terminal]
+----
+$ oc adm must-gather --image=ghcr.io/grafana/tempo-operator/must-gather -- \
+/usr/bin/must-gather --operator-namespace <operator_namespace> # <1>
+----
+<1> The default namespace where the Operator is installed is `openshift-tempo-operator`.
+
+.Verification
+
+* Verify that the new directory is created and contains the collected data.

modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc

@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// * observability/otel/otel-troubleshooting.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="otel-collecting-diagnostic-data-from-command-line_{context}"]
+= Collecting diagnostic data from the command line
+
+When submitting a support case, it is helpful to include diagnostic information about your cluster to Red Hat Support.
+You can use the `oc adm must-gather` tool to gather diagnostic data for resources of various types, such as `OpenTelemetryCollector`, `Instrumentation`, and the created resources like `Deployment`, `Pod`, or `ConfigMap`.
+The `oc adm must-gather` tool creates a new pod that collects this data.
+
+.Procedure
+
+* From the directory where you want to save the collected data, run the `oc adm must-gather` command to collect the data:
++
+[source,terminal]
+----
+$ oc adm must-gather --image=ghcr.io/open-telemetry/opentelemetry-operator/must-gather -- \
+/usr/bin/must-gather --operator-namespace <operator_namespace> # <1>
+----
+<1> The default namespace where the Operator is installed is `openshift-opentelemetry-operator`.
+
+.Verification
+
+* Verify that the new directory is created and contains the collected data.

observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc

@@ -0,0 +1,11 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="dist-tracing-tempo-troubleshooting"]
+= Troubleshooting
+include::_attributes/common-attributes.adoc[]
+:context: dist-tracing-tempo-troubleshooting
+
+toc::[]
+
+You can diagnose and fix issues in TempoStack or TempoMonolithic instances by using various troubleshooting methods.
+
+include::modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc[leveloffset=+1]

observability/otel/otel-troubleshooting.adoc

@@ -8,6 +8,7 @@ toc::[]
 
 The OpenTelemetry Collector offers multiple ways to measure its health as well as investigate data ingestion issues.
 
+include::modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc[leveloffset=+1]
 include::modules/otel-troubleshoot-collector-logs.adoc[leveloffset=+1]
 include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1]
 include::modules/otel-troubleshoot-logging-exporter-stdout.adoc[leveloffset=+1]