From 9a70ecbac6385a8743b4ec7a87da532a0f9e3afc Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Mon, 25 Nov 2024 08:54:43 +0100 Subject: [PATCH 1/3] WIP --- gdi/opentelemetry/troubleshoot-logs.rst | 32 ++++++++++++++++++------- gdi/opentelemetry/troubleshooting.rst | 9 +++---- 2 files changed, 27 insertions(+), 14 deletions(-) diff --git a/gdi/opentelemetry/troubleshoot-logs.rst b/gdi/opentelemetry/troubleshoot-logs.rst index d5e214982..9956f97c7 100644 --- a/gdi/opentelemetry/troubleshoot-logs.rst +++ b/gdi/opentelemetry/troubleshoot-logs.rst @@ -9,16 +9,32 @@ Troubleshoot log collection This document describes common issues related to log collection with the Collector. -.. note:: - - To collect logs see: - - * :ref:`kubernetes-config-logs` - * :ref:`linux-config-logs` - * :ref:`windows-config-logs` - To troubleshoot the health and performance of the Collector see the :new-page:`OpenTelemetry Project troublehooting docs `. It includes information about troubleshooting tools and debugging. +For more information on log collection and log collection troubleshooting see also: + +.. list-table:: + :width: 100% + :widths: 40 60 + :header-rows: 1 + + * - Platform + - Docs + + * - Kubernetes + - * :ref:`kubernetes-config-logs` + * :ref:`troubleshoot-k8s-landing` + * :ref:`troubleshoot-k8s` + * :ref:`troubleshoot-k8s-sizing` + * :ref:`troubleshoot-k8s-missing-metrics` + * :ref:`troubleshoot-k8s-container` + + * - Linux + - :ref:`linux-config-logs` + + * - Windows + - :ref:`windows-config-logs` + My source isn't generating logs ========================================= diff --git a/gdi/opentelemetry/troubleshooting.rst b/gdi/opentelemetry/troubleshooting.rst index 371a61da4..e689625ba 100644 --- a/gdi/opentelemetry/troubleshooting.rst +++ b/gdi/opentelemetry/troubleshooting.rst @@ -16,7 +16,7 @@ Troubleshoot the Collector Logs troubleshooting Support checklist -.. note:: To activate the Collector's debug logging, see the :new-page:`OpenTelemetry project documentation in GitHub `. +.. note:: To learn about the Collector's internal logs and other telemetry refer to the OpenTelemetry project :new-page:`Internal telemetry ` documentation. Here are some common issues that you might encounter when using the OpenTelemetry Collector and the Splunk Distribution of the OpenTelemetry Collector, and tips on how to address them. @@ -25,9 +25,6 @@ Here are some common issues that you might encounter when using the OpenTelemetr * :ref:`otel-support-checklist` * :ref:`support` -To :ref:`troubleshoot-k8s-landing`, see: -* :ref:`troubleshoot-k8s` -* :ref:`troubleshoot-k8s-sizing` -* :ref:`troubleshoot-k8s-missing-metrics` -* :ref:`troubleshoot-k8s-container` \ No newline at end of file + + From 890bc56b3650c3c589f15ce6b3970fbf84886056 Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Mon, 25 Nov 2024 11:26:43 +0100 Subject: [PATCH 2/3] Edits --- gdi/opentelemetry/splunk-collector-troubleshooting.rst | 6 ++++-- gdi/opentelemetry/troubleshoot-logs.rst | 9 ++------- gdi/opentelemetry/troubleshooting.rst | 5 +++++ 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/gdi/opentelemetry/splunk-collector-troubleshooting.rst b/gdi/opentelemetry/splunk-collector-troubleshooting.rst index 3cf5e22a1..198a9fa85 100644 --- a/gdi/opentelemetry/splunk-collector-troubleshooting.rst +++ b/gdi/opentelemetry/splunk-collector-troubleshooting.rst @@ -7,11 +7,13 @@ Troubleshoot the Splunk OpenTelemetry Collector .. meta:: :description: Describes known issues when using the Splunk Distribution of OpenTelemetry Collector. +.. caution:: Splunk only provides best-effort support for the upstream OpenTelemetry Collector. + See the following issues and workarounds for the Splunk Distribution of the OpenTelemetry Collector. -.. note:: See also the :new-page:`OpenTelemetry Project troublehooting docs `. +To understand how the Collector implements security see :ref:`otel-security`. -.. caution:: Splunk only provides best-effort support for the upstream OpenTelemetry Collector. +To learn about the Collector's internal logs and other telemetry refer to the OpenTelemetry project :new-page:`Internal telemetry ` documentation. The Collector isn't behaving as expected ================================================= diff --git a/gdi/opentelemetry/troubleshoot-logs.rst b/gdi/opentelemetry/troubleshoot-logs.rst index 9956f97c7..13b1119fe 100644 --- a/gdi/opentelemetry/troubleshoot-logs.rst +++ b/gdi/opentelemetry/troubleshoot-logs.rst @@ -11,11 +11,11 @@ This document describes common issues related to log collection with the Collect To troubleshoot the health and performance of the Collector see the :new-page:`OpenTelemetry Project troublehooting docs `. It includes information about troubleshooting tools and debugging. -For more information on log collection and log collection troubleshooting see also: +For more information on log collection see: .. list-table:: :width: 100% - :widths: 40 60 + :widths: 25 75 :header-rows: 1 * - Platform @@ -23,11 +23,6 @@ For more information on log collection and log collection troubleshooting see al * - Kubernetes - * :ref:`kubernetes-config-logs` - * :ref:`troubleshoot-k8s-landing` - * :ref:`troubleshoot-k8s` - * :ref:`troubleshoot-k8s-sizing` - * :ref:`troubleshoot-k8s-missing-metrics` - * :ref:`troubleshoot-k8s-container` * - Linux - :ref:`linux-config-logs` diff --git a/gdi/opentelemetry/troubleshooting.rst b/gdi/opentelemetry/troubleshooting.rst index e689625ba..c83270489 100644 --- a/gdi/opentelemetry/troubleshooting.rst +++ b/gdi/opentelemetry/troubleshooting.rst @@ -25,6 +25,11 @@ Here are some common issues that you might encounter when using the OpenTelemetr * :ref:`otel-support-checklist` * :ref:`support` +For :ref:`troubleshooting specific to the Collector for Kubernetes ` see: +* :ref:`troubleshoot-k8s` +* :ref:`troubleshoot-k8s-sizing` +* :ref:`troubleshoot-k8s-missing-metrics` +* :ref:`troubleshoot-k8s-container` From 935efc9affc54cf104834725694e09836f1dc405 Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Mon, 25 Nov 2024 11:54:24 +0100 Subject: [PATCH 3/3] Minor fixes --- gdi/opentelemetry/troubleshoot-logs.rst | 2 +- gdi/opentelemetry/troubleshooting.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/gdi/opentelemetry/troubleshoot-logs.rst b/gdi/opentelemetry/troubleshoot-logs.rst index 13b1119fe..7aebde865 100644 --- a/gdi/opentelemetry/troubleshoot-logs.rst +++ b/gdi/opentelemetry/troubleshoot-logs.rst @@ -22,7 +22,7 @@ For more information on log collection see: - Docs * - Kubernetes - - * :ref:`kubernetes-config-logs` + - :ref:`kubernetes-config-logs` * - Linux - :ref:`linux-config-logs` diff --git a/gdi/opentelemetry/troubleshooting.rst b/gdi/opentelemetry/troubleshooting.rst index c83270489..b5fda0cc1 100644 --- a/gdi/opentelemetry/troubleshooting.rst +++ b/gdi/opentelemetry/troubleshooting.rst @@ -13,7 +13,7 @@ Troubleshoot the Collector :hidden: General troubleshooting - Logs troubleshooting + Troubleshoot log collection Support checklist .. note:: To learn about the Collector's internal logs and other telemetry refer to the OpenTelemetry project :new-page:`Internal telemetry ` documentation.