Merge pull request #2450 from splunk/urbiz-OD6487-collector-ts-improvements

aurbiztondo-splunk · web-flow · commit e54ec590a6d3 · 2024-11-18T14:56:39.000+01:00
[6487]: Collector TS improvements
diff --git a/gdi/opentelemetry/collector-kubernetes/kubernetes-config-logs.rst b/gdi/opentelemetry/collector-kubernetes/kubernetes-config-logs.rst
@@ -2,7 +2,7 @@
 .. _kubernetes-config-logs:
 
 *********************************************************************************
-Collect logs and events for the Collector for Kubernetes
+Collect logs and events with the Collector for Kubernetes
 *********************************************************************************
 
 .. meta::
diff --git a/gdi/opentelemetry/collector-linux/linux-config-logs.rst b/gdi/opentelemetry/collector-linux/linux-config-logs.rst
@@ -2,7 +2,7 @@
 .. _linux-config-logs:
 
 ***************************************************************
-Collect logs for the Collector for Linux
+Collect logs with the Collector for Linux
 ***************************************************************
 
 .. meta::
diff --git a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst
@@ -17,6 +17,7 @@ Get started with the Collector for Windows
    Install the Collector for Windows (manually) <install-windows-manual.rst>       
    windows-config-ootb.rst
    windows-config.rst
+   windows-config-logs.rst
    metrics-ootb-windows.rst   
    windows-upgrade.rst   
    windows-uninstall.rst
@@ -31,8 +32,9 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Windows, f
 See the default settings and configuration options at:
 
 * :ref:`windows-config-ootb`
-* :ref:`otel-windows-config`
 * By default, you'll obtain these :ref:`metrics <ootb-metrics-windows>` 
+* :ref:`otel-windows-config`
+* :ref:`windows-config-logs`
 
 .. include:: /_includes/gdi/collector-common-options.rst
 
diff --git a/gdi/opentelemetry/collector-windows/install-windows.rst b/gdi/opentelemetry/collector-windows/install-windows.rst
@@ -167,55 +167,6 @@ The Windows installer script supports the following options:
      - Specify public MSI properties to be used when installing the Splunk OpenTelemetry Collector MSI package.
      -
 
-.. _windows-config-logs:
-
-Collect logs for the Collector for Windows
-====================================================================
-
-Use the Universal Forwarder to send logs to the Splunk platform. See more at :ref:`collector-with-the-uf`.
-
-.. _fluentd-manual-config-windows:
-
-Collect Windows logs with Fluentd
----------------------------------------
-
-If you wish to collect logs for the target host with Fluentd, use the ``with_fluentd = 1`` option to install and enable Fluentd when installing the Collector. For example:
-
-.. code-block:: PowerShell
-
-  & {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; with_fluentd = 1}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
-
-When activated, the Fluentd service is configured by default to collect and forward log events with the ``@SPLUNK`` label to the Collector, which then send these events to the HEC ingest endpoint determined by the ``realm = "<SPLUNK_REALM>"`` option.
-For example, ``https://ingest.<SPLUNK_REALM>.signalfx.com/v1/log``.
-
-To configure the package to send log events to a custom HTTP Event Collector (HEC) endpoint URL with a token different than ``<SPLUNK_ACCESS_TOKEN>``, you can specify the following parameters for the installer script:
-
-* ``hec_url = "<SPLUNK_HEC_URL>"``
-* ``hec_token = "<SPLUNK_HEC_TOKEN>"``
-
-For example (replace the ``<SPLUNK...>`` values in the command for your configuration):
-
-.. code-block:: PowerShell
-
-  & {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; hec_url = "<SPLUNK_HEC_URL>"; hec_token = "<SPLUNK_HEC_TOKEN>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
-
-The installation creates the main fluentd configuration file  ``<drive>\opt\td-agent\etc\td-agent\td-agent.conf``, where ``<drive>`` is the drive letter for the fluentd installation directory.
-
-You can add custom fluentd source configuration files to the ``<drive>\opt\td-agent\etc\td-agent\conf.d``
-directory after installation.
-
-Note the following:
-
-* In this directory, fluentd includes all files with the .conf extension.
-* By default, fluentd collects from the Windows Event Log. See ``<drive>\opt\td-agent\etc\td-agent\conf.d\eventlog.conf`` for the default configuration.
-
-After any configuration modification, apply the changes by restarting the system or running the following PowerShell commands:
-
-.. code-block:: PowerShell
-
-  Stop-Service fluentdwinsvc
-  Start-Service fluentdwinsvc
-
 Next steps
 ==================================
 
diff --git a/gdi/opentelemetry/collector-windows/windows-config-logs.rst b/gdi/opentelemetry/collector-windows/windows-config-logs.rst
@@ -0,0 +1,59 @@
+.. _windows-config-logs:
+
+***************************************************************
+Collect logs with the Collector for Windows
+***************************************************************
+
+.. meta::
+  
+  :description: Describes how to collect logs for the Splunk Distribution of OpenTelemetry Collector for Linux.
+
+Use the Universal Forwarder to send logs to the Splunk platform. See more at :ref:`collector-with-the-uf`.
+
+.. _fluentd-manual-config-windows:
+
+Collect Windows logs with Fluentd
+===========================================================================
+
+Fluentd is turned off by default. 
+
+If you wish to collect logs for the target host with Fluentd, use the ``with_fluentd = 1`` option to install and enable Fluentd when installing the Collector. 
+
+For example:
+
+.. code-block:: PowerShell
+
+  & {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; with_fluentd = 1}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
+
+When activated, the Fluentd service is configured by default to collect and forward log events with the ``@SPLUNK`` label to the Collector, which then send these events to the HEC ingest endpoint determined by the ``realm = "<SPLUNK_REALM>"`` option.
+For example, ``https://ingest.<SPLUNK_REALM>.signalfx.com/v1/log``.
+
+To configure the package to send log events to a custom HTTP Event Collector (HEC) endpoint URL with a token different than ``<SPLUNK_ACCESS_TOKEN>``, you can specify the following parameters for the installer script:
+
+* ``hec_url = "<SPLUNK_HEC_URL>"``
+* ``hec_token = "<SPLUNK_HEC_TOKEN>"``
+
+For example (replace the ``<SPLUNK...>`` values in the command for your configuration):
+
+.. code-block:: PowerShell
+
+  & {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; hec_url = "<SPLUNK_HEC_URL>"; hec_token = "<SPLUNK_HEC_TOKEN>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
+
+The installation creates the main Fluentd configuration file  ``<drive>\opt\td-agent\etc\td-agent\td-agent.conf``, where ``<drive>`` is the drive letter for the fluentd installation directory.
+
+You can add custom Fluentd source configuration files to the ``<drive>\opt\td-agent\etc\td-agent\conf.d``
+directory after installation.
+
+Note the following:
+
+* In this directory, Fluentd includes all files with the .conf extension.
+* By default, fluentd collects from the Windows Event Log. See ``<drive>\opt\td-agent\etc\td-agent\conf.d\eventlog.conf`` for the default configuration.
+
+After any configuration modification, apply the changes by restarting the system or running the following PowerShell commands:
+
+.. code-block:: PowerShell
+
+  Stop-Service fluentdwinsvc
+  Start-Service fluentdwinsvc
+
+
diff --git a/gdi/opentelemetry/troubleshoot-logs.rst b/gdi/opentelemetry/troubleshoot-logs.rst
@@ -9,6 +9,14 @@ 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 <https://opentelemetry.io/docs/collector/troubleshooting>`. It includes information about troubleshooting tools and debugging.
 
 My source isn't generating logs
@@ -69,9 +77,7 @@ You can manually generate logs. By default, Fluentd monitors journald and /var/l
   echo "2021-03-17 02:14:44 +0000 [debug]: test" >>/var/log/syslog.log
   echo "2021-03-17 02:14:44 +0000 [debug]: test" | systemd-cat
 
-.. note::
-
-  Properly structured syslog is required for Fluentd to properly pick up the log line.
+.. caution:: Fluentd requires properly structured syslog to pick up the log line.
 
 .. _unwanted_profiling_logs:
 
