Merge pull request #70681 from abrennan89/troublesh

abrennan89 · web-flow · commit a837529163c1 · 2024-01-26T10:04:51.000-06:00
OBSDOCS-642: Troubleshooting logging docs cleanup
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2560,6 +2560,17 @@ Topics:
     File: logging-5-7-release-notes
 - Name: Support
   File: cluster-logging-support
+- Name: Troubleshooting logging
+  Dir: troubleshooting
+  Topics:
+  - Name: Viewing Logging status
+    File: cluster-logging-cluster-status
+  - Name: Troubleshooting log forwarding
+    File: log-forwarding-troubleshooting
+  - Name: Troubleshooting logging alerts
+    File: troubleshooting-logging-alerts
+  - Name: Viewing the status of the Elasticsearch log store
+    File: cluster-logging-log-store-status
 - Name: About Logging
   File: cluster-logging
 - Name: Installing Logging
@@ -2605,8 +2616,6 @@ Topics:
     File: cluster-logging-collector
   - Name: Collecting and storing Kubernetes events
     File: cluster-logging-eventrouter
-  - Name: Troubleshooting log forwarding
-    File: log-forwarding-troubleshooting
 - Name: Log storage
   Dir: log_storage
   Topics:
@@ -2625,21 +2634,11 @@ Topics:
     File: default-logging-alerts
   - Name: Custom logging alerts
     File: custom-logging-alerts
-  - Name: Troubleshooting logging alerts
-    File: troubleshooting-logging-alerts
 - Name: Performance and reliability tuning
   Dir: performance_reliability
   Topics:
   - Name: Flow control mechanisms
     File: logging-flow-control-mechanisms
-- Name: Troubleshooting Logging
-  Dir: troubleshooting
-  Distros: openshift-enterprise,openshift-origin
-  Topics:
-  - Name: Viewing Logging status
-    File: cluster-logging-cluster-status
-  - Name: Viewing the status of the Elasticsearch log store
-    File: cluster-logging-log-store-status
 - Name: Uninstalling Logging
   File: cluster-logging-uninstall
 - Name: Exported fields
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -1042,6 +1042,17 @@ Topics:
     File: logging-5-7-release-notes
 - Name: Support
   File: cluster-logging-support
+- Name: Troubleshooting logging
+  Dir: troubleshooting
+  Topics:
+  - Name: Viewing Logging status
+    File: cluster-logging-cluster-status
+  - Name: Troubleshooting log forwarding
+    File: log-forwarding-troubleshooting
+  - Name: Troubleshooting logging alerts
+    File: troubleshooting-logging-alerts
+  - Name: Viewing the status of the Elasticsearch log store
+    File: cluster-logging-log-store-status
 - Name: About Logging
   File: cluster-logging
 - Name: Installing Logging
@@ -1087,8 +1098,6 @@ Topics:
     File: cluster-logging-collector
   - Name: Collecting and storing Kubernetes events
     File: cluster-logging-eventrouter
-  - Name: Troubleshooting log forwarding
-    File: log-forwarding-troubleshooting
 - Name: Log storage
   Dir: log_storage
   Topics:
@@ -1107,20 +1116,11 @@ Topics:
     File: default-logging-alerts
   - Name: Custom logging alerts
     File: custom-logging-alerts
-  - Name: Troubleshooting logging alerts
-    File: troubleshooting-logging-alerts
 - Name: Performance and reliability tuning
   Dir: performance_reliability
   Topics:
   - Name: Flow control mechanisms
     File: logging-flow-control-mechanisms
-- Name: Troubleshooting Logging
-  Dir: troubleshooting
-  Topics:
-  - Name: Viewing Logging status
-    File: cluster-logging-cluster-status
-  - Name: Viewing the status of the Elasticsearch log store
-    File: cluster-logging-log-store-status
 - Name: Uninstalling Logging
   File: cluster-logging-uninstall
 - Name: Exported fields
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -1265,6 +1265,17 @@ Topics:
     File: logging-5-7-release-notes
 - Name: Support
   File: cluster-logging-support
+- Name: Troubleshooting logging
+  Dir: troubleshooting
+  Topics:
+  - Name: Viewing Logging status
+    File: cluster-logging-cluster-status
+  - Name: Troubleshooting log forwarding
+    File: log-forwarding-troubleshooting
+  - Name: Troubleshooting logging alerts
+    File: troubleshooting-logging-alerts
+  - Name: Viewing the status of the Elasticsearch log store
+    File: cluster-logging-log-store-status
 - Name: About Logging
   File: cluster-logging
 - Name: Installing Logging
@@ -1312,8 +1323,6 @@ Topics:
     File: cluster-logging-collector
   - Name: Collecting and storing Kubernetes events
     File: cluster-logging-eventrouter
-  - Name: Troubleshooting log forwarding
-    File: log-forwarding-troubleshooting
 - Name: Log storage
   Dir: log_storage
   Topics:
@@ -1332,20 +1341,11 @@ Topics:
     File: default-logging-alerts
   - Name: Custom logging alerts
     File: custom-logging-alerts
-  - Name: Troubleshooting logging alerts
-    File: troubleshooting-logging-alerts
 - Name: Performance and reliability tuning
   Dir: performance_reliability
   Topics:
   - Name: Flow control mechanisms
     File: logging-flow-control-mechanisms
-- Name: Troubleshooting Logging
-  Dir: troubleshooting
-  Topics:
-  - Name: Viewing Logging status
-    File: cluster-logging-cluster-status
-  - Name: Viewing the status of the Elasticsearch log store
-    File: cluster-logging-log-store-status
 - Name: Uninstalling Logging
   File: cluster-logging-uninstall
 - Name: Exported fields
diff --git a/logging/troubleshooting/log-forwarding-troubleshooting.adoc b/logging/troubleshooting/log-forwarding-troubleshooting.adoc
diff --git a/logging/troubleshooting/troubleshooting-logging-alerts.adoc b/logging/troubleshooting/troubleshooting-logging-alerts.adoc
diff --git a/modules/cluster-logging-clo-status-comp.adoc b/modules/cluster-logging-clo-status-comp.adoc
@@ -1,9 +1,9 @@
 // Module included in the following assemblies:
 //
-// * logging/cluster-logging-cluster-status.adoc
+// * logging/troubleshooting/cluster-logging-cluster-status.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="cluster-logging-clo-status-example_{context}"]
+[id="cluster-logging-clo-status-comp_{context}"]
 = Viewing the status of {logging} components
 
 You can view the status for a number of {logging} components.
diff --git a/modules/cluster-logging-clo-status.adoc b/modules/cluster-logging-clo-status.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/cluster-logging-cluster-status.adoc
+// * logging/troubleshooting/cluster-logging-cluster-status.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cluster-logging-clo-status_{context}"]
diff --git a/modules/es-cluster-health-is-red.adoc b/modules/es-cluster-health-is-red.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/logging_alerts/troubleshooting-logging-alerts.adoc
+// * logging/troubleshooting/troubleshooting-logging-alerts.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="es-cluster-health-is-red_{context}"]
diff --git a/modules/es-disk-space-low.adoc b/modules/es-disk-space-low.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/logging_alerts/troubleshooting-logging-alerts.adoc
+// * logging/troubleshooting/troubleshooting-logging-alerts.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="es-disk-space-low_{context}"]
diff --git a/modules/es-node-disk-flood-watermark-reached.adoc b/modules/es-node-disk-flood-watermark-reached.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/logging_alerts/troubleshooting-logging-alerts.adoc
+// * logging/troubleshooting/troubleshooting-logging-alerts.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="es-node-disk-flood-watermark-reached_{context}"]
diff --git a/modules/es-node-disk-high-watermark-reached.adoc b/modules/es-node-disk-high-watermark-reached.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/logging_alerts/troubleshooting-logging-alerts.adoc
+// * logging/troubleshooting/troubleshooting-logging-alerts.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="es-node-disk-high-watermark-reached_{context}"]
diff --git a/modules/es-node-disk-low-watermark-reached.adoc b/modules/es-node-disk-low-watermark-reached.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/logging_alerts/troubleshooting-logging-alerts.adoc
+// * logging/troubleshooting/troubleshooting-logging-alerts.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="es-node-disk-low-watermark-reached_{context}"]
diff --git a/modules/loki-rate-limit-errors.adoc b/modules/loki-rate-limit-errors.adoc
@@ -1,6 +1,7 @@
 // Module is included in the following assemblies:
 // * logging/cluster-logging-loki.adoc
 // * logging/log_collection_forwarding/log-forwarding.adoc
+// * logging/troubleshooting/log-forwarding-troubleshooting.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="loki-rate-limit-errors_{context}"]
diff --git a/modules/redeploying-fluentd-pods.adoc b/modules/redeploying-fluentd-pods.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/log_collection_forwarding/log-forwarding-troubleshooting.adoc
+// * logging/troubleshooting/log-forwarding-troubleshooting.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="redeploying-fluentd-pods_{context}"]
diff --git a/support/index.adoc b/support/index.adoc
@@ -125,11 +125,11 @@ endif::openshift-rosa,openshift-dedicated[]
 ** Investigate why user-defined metrics are unavailable.
 ** Determine why Prometheus is consuming a lot of disk space.
 
-* xref:../logging/cluster-logging.adoc#cluster-logging[Logging issues]: A cluster administrator can follow the procedures on the troubleshooting page for OpenShift Logging issues. Check the following to resolve logging issues:
+* xref:../logging/cluster-logging.adoc#cluster-logging[Logging issues]: A cluster administrator can follow the procedures in the "Support" and "Troubleshooting logging" sections to resolve logging issues:
 
-** xref:../logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-cluster-status[Status of the Logging Operator].
-** xref:../logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-cluster-status[Status of the Log store].
-** xref:../logging/logging_alerts/troubleshooting-logging-alerts.adoc#troubleshooting-logging-alerts[Troubleshooting logging alerts].
-** xref:../logging/cluster-logging-support.adoc#cluster-logging-support-must-gather_cluster-logging-support[Information about your OpenShift logging environment using `oc adm must-gather` command].
+** xref:../logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status_cluster-logging-cluster-status[Viewing the status of the {clo}].
+** xref:../logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status-comp_cluster-logging-cluster-status[Viewing the status of {logging} components].
+** xref:../logging/troubleshooting/troubleshooting-logging-alerts.adoc#troubleshooting-logging-alerts[Troubleshooting logging alerts].
+** xref:../logging/cluster-logging-support.adoc#cluster-logging-must-gather-collecting_cluster-logging-support[Collecting information about your logging environment by using the `oc adm must-gather` command].
 
-* xref:../support/troubleshooting/diagnosing-oc-issues.adoc#diagnosing-oc-issues[OpenShift CLI (oc) issues]: Investigate OpenShift CLI (oc) issues by increasing the log level.
+* xref:../support/troubleshooting/diagnosing-oc-issues.adoc#diagnosing-oc-issues[{oc-first} issues]: Investigate {oc-first} issues by increasing the log level.
