WIP

aurbiztondo-splunk · aurbiztondo-splunk · commit 078cfc490701 · 2024-07-04T16:13:57.000+02:00
diff --git a/gdi/opentelemetry/collector-windows/install-windows-manual.rst b/gdi/opentelemetry/collector-windows/install-windows-manual.rst
@@ -14,6 +14,12 @@ Install the Collector for Windows manually
 
 You can use Windows MSI to install the Splunk Distribution of the Collector for Windows.
 
+.. note:: 
+  
+  The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. To modify this configuration, refer to :ref:`otel-windows-config`.
+
+  To learn how to obtain logs, see :ref:`windows-config-logs`.
+
 Alternatively, you can also install the Collector for Windows:
 
 * Using the installer script. See :ref:`otel-install-windows`. 
@@ -78,22 +84,6 @@ To install the Collector using the binary file, follow these steps:
 
   # type Ctrl-c to stop the collector
 
-.. _install-windows-manual-modify-default:
-
-Modify the default configuration
-==========================================
-
-All installation methods offer default configurations using environment variables. Before starting the ``splunk-otel-collector`` service, replace the variables in the default configuration file with the appropriate values for your environment. See :ref:`otel-windows-config` for more information.
-
-.. include:: /_includes/collector-env-vars.rst
-
-.. note:: When configuring additional settings, use service, process, or terminal scopes.  
-
-Configure proxy settings
-----------------------------------
-
-To configure proxy settings to install and run the OpenTelemetry Collector, see :ref:`configure-proxy-collector`.  
-
 .. _windows-manual-custom:
 
 Use a custom configuration file
diff --git a/gdi/opentelemetry/collector-windows/install-windows-msi.rst b/gdi/opentelemetry/collector-windows/install-windows-msi.rst
@@ -14,6 +14,12 @@ Install the Collector for Windows using MSI
 
 You can use Windows MSI to install the Splunk Distribution of the Collector for Windows.
 
+.. note:: 
+  
+  The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. To modify this configuration, refer to :ref:`otel-windows-config`.
+
+  To learn how to obtain logs, see :ref:`windows-config-logs`.
+
 Alternatively, you can also install the Collector for Windows:
 
 * Using the installer script. See :ref:`otel-install-windows`. 
@@ -27,19 +33,12 @@ Prerequisites
 
 .. include:: /_includes/requirements/collector-windows.rst
 
-.. _install-windows-msi-env-variables:
-
-Collector environment variables
-=====================================
-
-.. include:: /_includes/collector-env-vars.rst
-
 .. _windows-installer:
 
 Install the Collector using the Windows installer file (MSI) 
 ===============================================================================
 
-To install the package using Windows Installer, download the Windows MSI package (64-bit only) from :new-page:`GitHub releases <https://github.com/signalfx/splunk-otel-collector/releases>`.
+To install the package using Windows Installer, download the Windows MSI package (64-bit only) from the Collector's :new-page:`GitHub release site <https://github.com/signalfx/splunk-otel-collector/releases>`.
 
   - The package is installed to ``\Program Files\Splunk\OpenTelemetry Collector``.
   - The ``splunk-otel-collector`` service is created, but not started.
@@ -70,27 +69,24 @@ Follow these steps:
 
     Start-Process -Wait msiexec "/i PATH_TO_MSI /qn"  
 
-1. Update all variables in the configuration file as appropriate. See :ref:`install-windows-msi-env-variables`.
+1. Update all variables in the configuration file as appropriate. See :ref:`install-windows-msi-modify-default`.
 2. Start the ``splunk-otel-collector`` service by rebooting the system or by running the following command in a PowerShell terminal:
 
   .. code-block:: PowerShell
 
     Start-Service splunk-otel-collector
 
-Learn more about advanced configuration options (including Service Logging) using PowerShell in the Splunk Distribution of OpenTelemetry Collector :new-page:`Windows manual <https://github.com/signalfx/splunk-otel-collector/blob/main/docs/getting-started/windows-manual.md>`.
+Learn more about advanced configuration options (including Service Logging) using PowerShell in the following docs: 
+
+* :ref:`otel-install-windows-manual`
+* :ref:`otel-windows-config`
 
 .. _windows-manual-fluentd:
 
 Install Fluentd MSI for log collection
 ==================================================
 
-Default log collection
------------------------------------------------
-
-Install, configure, and start the Collector with :ref:`Windows Installer <windows-installer>`. The Collector default configuration file ``\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml`` listens for log events on ``127.0.0.1:8006`` and sends them to Splunk Observability Cloud.
-
-Log collection with Fluentd
------------------------------------------------
+If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance. 
 
 .. note:: You need to be an Admin to configure log collection with Fluentd.
 
@@ -117,34 +113,28 @@ Perform the following steps to install Fluentd and forward ``collected`` log eve
 
 Learn more about general Fluentd configuration details in the :new-page:`official Fluentd documentation <https://docs.fluentd.org/configuration>`.
 
-.. _windows-chocolatey:
+Custom MSI URLs
+==================================================
 
-Install using a Chocolatey package
-===========================================
+By default, the Collector MSI is downloaded from :new-page:`https://dl.signalfx.com <https://dl.signalfx.com>` and
+the Fluentd MSI is downloaded from :new-page:`https://packages.treasuredata.com <https://packages.treasuredata.com>`.  
 
-A :new-page:`Chocolatey package <https://community.chocolatey.org/packages/splunk-otel-collector>` is available to download, install, and configure the Collector and Fluentd with the following PowerShell command:  
+To specify custom URLs for these downloads, use the ``collector_msi_url`` and ``fluentd_msi_url`` options. Replace ``COLLECTOR_MSI_URL`` and ``FLUENTD_MSI_URL`` with the URLs to the desired MSI packages to install:
 
 .. code-block:: PowerShell
 
-  choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"
-
-Learn more about the :new-page:`package parameters <https://github.com/signalfx/splunk-otel-collector/blob/main/docs/getting-started/windows-manual.md#package-parameters>` in GitHub.
-
-.. _install-windows-msi-modify-default:
-
-Modify the default configuration
-==========================================
+  & {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>"; collector_msi_url = "<COLLECTOR_MSI_URL>"; fluentd_msi_url = "<FLUENTD_MSI_URL>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
 
-All installation methods offer default configurations using environment variables. Before starting the ``splunk-otel-collector`` service, replace the variables in the default configuration file with the appropriate values for your environment. See :ref:`otel-windows-config` for more information.
+.. _windows-chocolatey:
 
-.. include:: /_includes/collector-env-vars.rst
+Install using a Chocolatey package
+===========================================
 
-.. note:: When configuring additional settings, use service, process, or terminal scopes.  
+A :new-page:`Chocolatey package <https://community.chocolatey.org/packages/splunk-otel-collector>` is available to download, install, and configure the Collector and Fluentd with the following PowerShell command:  
 
-Configure proxy settings
-----------------------------------
+.. code-block:: PowerShell
 
-To configure proxy settings to install and run the OpenTelemetry Collector, see :ref:`configure-proxy-collector`.  
+  choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"
 
 Next steps
 ==================================
diff --git a/gdi/opentelemetry/collector-windows/install-windows-tools.rst b/gdi/opentelemetry/collector-windows/install-windows-tools.rst
@@ -20,6 +20,12 @@ forwarding for all data types. You can install it using the following deployment
 * :ref:`windows-nomad`
 * :ref:`windows-puppet`
 
+.. note:: 
+  
+  The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. To modify this configuration, refer to :ref:`otel-windows-config`.
+
+  To learn how to obtain logs, see :ref:`windows-config-logs`.
+
 Alternatively, you can also install the Collector for Windows:
 
 * Using the installer script. See :ref:`otel-install-windows`. 
diff --git a/gdi/opentelemetry/collector-windows/install-windows.rst b/gdi/opentelemetry/collector-windows/install-windows.rst
@@ -14,7 +14,11 @@ Install the Collector for Windows with the installer script
 The Splunk Distribution of the OpenTelemetry Collector for Windows is a package that provides integrated collection and
 forwarding for all data types. Read on to see how to install it using the installer script.
 
-.. note:: The Collector comes with a default configuration. To learn more, see :ref:`windows-config-ootb`.
+.. note:: 
+  
+  The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. To modify this configuration, refer to :ref:`otel-windows-config`.
+
+  To learn how to obtain logs, see :ref:`windows-config-logs`.
 
 Alternatively, you can also install the Collector for Windows:
 
@@ -163,15 +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.
      -
 
-.. _otel-install-windows-modify:
-
-Modify the default configuration
-=========================================
-
-The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. This configuration can be modified as needed. See :ref:`otel-windows-config` for more information.
-
-For more information about the Collector's environment variables, see :ref:`collector-env-var`.
-
 Next steps
 ==================================
 
diff --git a/gdi/opentelemetry/collector-windows/windows-config.rst b/gdi/opentelemetry/collector-windows/windows-config.rst
@@ -9,15 +9,18 @@ Advanced configuration for Windows
 
 The Collector comes with a default configuration. To learn more, see :ref:`windows-config-ootb`.
 
-Configuration variables
-==========================================
+.. _windows-config-change-default:
+
+Change the default configuration file for the Collector for Windows
+==============================================================================
+
+All installation methods offer default configurations using environment variables. Before starting the ``splunk-otel-collector`` service, replace the variables in the default configuration file with the appropriate values for your environment.
 
 .. include:: /_includes/collector-env-vars.rst
 
-Change the default configuration file
-==========================================
+.. note:: When configuring additional settings, use service, process, or terminal scopes.    
 
-Before starting the ``splunk-otel-collector`` service, change the variables in the default configuration file to the appropriate values for your environment. Based on the specified installation parameters, the environment variables are saved to the ``HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector`` registry key and set on the ``Environment`` entry.
+Based on the specified installation parameters, the environment variables are saved to the ``HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector`` registry key and set on the ``Environment`` entry.
 
 To modify any of the configuration values, run ``regedit`` and browse to the path.
 
@@ -40,31 +43,25 @@ Configure proxy settings
 
 To configure proxy settings to install and run the OpenTelemetry Collector, see :ref:`configure-proxy-collector`.
 
-Custom MSI URLs
-----------------------------------
-
-By default, the Collector MSI is downloaded from :new-page:`https://dl.signalfx.com <https://dl.signalfx.com>` and
-the Fluentd MSI is downloaded from :new-page:`https://packages.treasuredata.com <https://packages.treasuredata.com>`.  
-
-To specify custom URLs for these downloads, use the ``collector_msi_url`` and ``fluentd_msi_url`` options. Replace ``COLLECTOR_MSI_URL`` and ``FLUENTD_MSI_URL`` with the URLs to the desired MSI packages to install:
+.. _windows-config-logs:
 
-.. code-block:: PowerShell
+Configure log collection for the Collector for Windows
+====================================================================
 
-  & {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>"; collector_msi_url = "<COLLECTOR_MSI_URL>"; fluentd_msi_url = "<FLUENTD_MSI_URL>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
+For Windows environments (physical hosts and virtual machines), use the Universal Forwarder to send logs to the Splunk platform. See more at :ref:`collector-with-the-uf`.
 
 .. _fluentd-manual-config-windows:
 
 Configure Fluentd for log collection
-====================================================================
+--------------------------------------------------------------------
 
-If you have a Log Observer entitlement or wish to collect logs for the target host with Fluentd, use the ``with_fluentd = 1`` option to also install Fluentd when installing the Collector. For example:
+If you have a Log Observer entitlement or 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.
+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:
diff --git a/gdi/opentelemetry/opentelemetry.rst b/gdi/opentelemetry/opentelemetry.rst
@@ -37,8 +37,6 @@ Learn more about the Splunk Observability Cloud data model at :ref:`data-model`.
 
 .. include:: /_includes/collector-works.rst
 
-Learn more at :ref:`otel-understand-use`.  
-
 .. raw:: html
 
   <embed>
@@ -199,16 +197,15 @@ The Collector also offers a :ref:`zPages extension <zpages-extension>`, which pr
     <h2>Available features for the Collector<a name="otel-using" class="headerlink" href="#otel-using" title="Permalink to this headline">¶</a></h2>
   </embed>
 
-See the features available for the Collector:
+After installing the Collector, read :ref:`otel-understand-use`.  
 
 * See how to perform common actions and tasks with the Collector at :ref:`collector-how-to`. For example, learn how to :ref:`collector-remove-data` to strip data out of your telemetry, including PII.
-* Learn about automatic discovery and configuration (formerly zero configuration auto instrumentation) to detect telemetry data. See :ref:`discovery_mode`.
-* Activate automatic discovery so that the Collector can automatically grab traces from your application, and add metrics for certain types of calls. See :ref:`discovery_mode`.
+* Learn about automatic discovery and configuration (formerly zero configuration auto instrumentation) to detect telemetry data. Automatic discovery allows the Collector to automatically grab traces from your application, and add metrics for certain types of calls. See :ref:`discovery_mode`.
 
-For more information:
+For more information see also:
 
 - :ref:`otel-troubleshooting`. Try these troubleshooting techniques and learn how to open a support request.
-- Read :ref:`otel-collector-scenario`.
+- :ref:`otel-collector-scenario`.
 
 .. _otel-intro-enterprise:
 
