WIP

aurbiztondo-splunk · aurbiztondo-splunk · commit fcdb9f33d38d · 2024-11-27T16:59:09.000+01:00
diff --git a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst
@@ -22,4 +22,6 @@ Automatic discovery for Linux
 
 To enable the Collector's zero-code instrumentation of back-end applications written in Java, Node.js, and .NET see :ref:`linux-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately. 
 
-To use the Collector's automatic discovery and configuration of third-party applications in Linux environments see :ref:`linux-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector. 
+To use the Collector's automatic discovery and configuration of third-party applications in Linux environments see :ref:`linux-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector. 
+
+For advanced auto discovery configuration see :ref:`linux-advanced-auto-discovery-config`.
diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst
@@ -1,22 +1,20 @@
 .. _linux-advanced-auto-discovery-config:
 
 *****************************************************************************
-Advanced customization for automatic discovery and instrumentation in Linux
+Advanced customization for automatic discovery in Linux
 *****************************************************************************
 
 .. meta:: 
     :description: Learn how to customize your deployment of automatic discovery and instrumentation in a Linux environment.
 
-Learn how to customize automatic discovery and instrumentation for advanced scenarios. 
+Learn how to customize automatic discovery and zero-code instrumentation for advanced scenarios. 
 
 Through advanced customization, you can achieve the following tasks:
 
 * :ref:`Override automatic instrumentation settings <override-default-settings-linux>`
 * :ref:`Use automatic discovery with gateway mode <use-with-gateway-linux>`
 * :ref:`Customize discovery settings for third-party applications <customize-third-party-settings-linux>`
 
-.. note:: For advanced customization options in Kubernetes, see :ref:`k8s-advanced-auto-discovery-config`.
-
 .. _override-default-settings-linux:
 
 Override default automatic instrumentation settings
@@ -76,6 +74,8 @@ To activate runtime metrics collection for an individual language, follow these
 #. Set the environment variable ``SPLUNK_METRICS_ENABLED=true``.
 #. Restart your applications.
 
+
+
 .. _use-with-gateway-linux:
 
 Use automatic discovery with gateway mode
diff --git a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst
@@ -43,32 +43,31 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes
 * :ref:`kubernetes-helm-architecture`
 * :ref:`kubernetes-helm-releases`
 
+.. note:: By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`. 
+
 Optionally, you can also:
 
 * :ref:`otel-install-k8s-manifests`
 * :ref:`Deploy the Collector as an AWS EKS Add-on <install-k8s-addon-eks>`
-* Deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
-
-.. note:: By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`. 
+* Deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`
 
 .. raw:: html
 
   <embed>
     <h2>Configure the Collector for Kubernetes<a name="k8s-configure" class="headerlink" href="#k8s-configure" title="Permalink to this headline">¶</a></h2>
   </embed>
 
-To configure the Collector, including adding additional components or activating automatic discovery, see:
+.. note:: To deploy the Collector for Kubernetes and automatically find services and applications running in your environment refer to :ref:`discovery-kubernetes`.   
+
+To configure the Collector see:
 
 * :ref:`otel-kubernetes-config`
 * :ref:`kubernetes-config-add` 
-* :ref:`discovery-mode-k8s`
 * :ref:`kubernetes-config-logs`
 * :ref:`otel-kubernetes-config-advanced`
 
 .. include:: /_includes/gdi/collector-common-options.rst
 
-To automatically find services and applications running in your Kubernetes environment and send data from them to Splunk Observability Cloud refer to :ref:`discovery-kubernetes`.     
-
 .. raw:: html
 
   <embed>
diff --git a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst
@@ -24,12 +24,26 @@ Get started with the Collector for Linux
 
 To install and configure the Splunk Distribution of the OpenTelemetry Collector for Linux, follow these docs:
 
+.. raw:: html
+
+  <embed>
+    <h2>Install the Collector for Linux<a name="linux-install" class="headerlink" href="#linux-install" title="Permalink to this headline">¶</a></h2>
+  </embed>
+
 * :ref:`otel-install-linux`
 * :ref:`otel-install-linux-manual`
 * :ref:`otel-install-linux-tools` 
 
 .. note:: You can also deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
 
+.. raw:: html
+
+  <embed>
+    <h2>Configure the Collector for Linux<a name="linux-configure" class="headerlink" href="#linux-configure" title="Permalink to this headline">¶</a></h2>
+  </embed>
+
+.. note:: To deploy the Collector for Linux and automatically find services and applications running in your environment refer to :ref:`discovery-linux`.   
+
 See the default settings and configuration options at:
 
 * :ref:`linux-config-ootb`
@@ -39,13 +53,24 @@ See the default settings and configuration options at:
 
 .. include:: /_includes/gdi/collector-common-options.rst
 
-To automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud refer to :ref:`discovery-linux`.   
+.. raw:: html
+
+  <embed>
+    <h2>Upgrade, uninstall and troubleshoot<a name="linux-ts" class="headerlink" href="#linux-ts" title="Permalink to this headline">¶</a></h2>
+  </embed>
+
 
 To upgrade or uninstall, see:
 
 * :ref:`otel-linux-upgrade` 
 * :ref:`otel-linux-uninstall`
 
-.. note:: If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting`.
+If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting`.
+
+.. raw:: html
+
+  <embed>
+    <h2>Tutorials<a name="linux-tutorials" class="headerlink" href="#linux-tutorials" title="Permalink to this headline">¶</a></h2>
+  </embed>
 
 For a walkthrough of common tasks related to the OpenTelemetry Collector for Linux see: :ref:`about-collector-configuration-tutorial`.
diff --git a/gdi/opentelemetry/collector-linux/install-linux.rst b/gdi/opentelemetry/collector-linux/install-linux.rst
@@ -92,52 +92,12 @@ Configure automatic discovery for back-end applications
 
 You can also automatically instrument your Java, Node.js, and .NET applications along with the Collector installation. Automatic discovery removes the need to configure receivers for each back-end application. See :ref:`linux-backend-auto-discovery` for the installation instructions. 
 
-For more information on instrumentation, see: 
+For more information on APM instrumentation, see: 
 
 * :ref:`get-started-java` 
 * :ref:`get-started-nodejs`
 * :ref:`get-started-dotnet-otel`    
 
-.. _collector-linux-with-docker:
-
-Collector for Linux with Docker
-====================================================================
-
-Install the Collector in a host with Docker
---------------------------------------------------------------------
-
-If you're installing your Collector instance in a host with Docker, you need to configure a client to establish a connection with the daemon. Depending on your Docker installation and Collector deployment method, try one of these options:
-
-1. If your daemon is listening to a domain socket (for example ``/var/run/docker.sock``), your Collector service or executable needs appropriate permissions and access. Add the ``splunk-otel-collector`` user to the Docker group as configured on your system:
-
-  .. code-block:: bash
-
-    $ usermod -aG docker splunk-otel-collector
-
-2. When using the :new-page:`quay.io/signalfx/splunk-otel-collector <https://quay.io/repository/signalfx/splunk-otel-collector>` image, add the default container user to the required group as configured on your system, and the bind and mount the domain socket:
-
-  .. code-block:: bash
-
-    $ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add $(stat -c '%g' /var/run/docker.sock) quay.io/signalfx/splunk-otel-collector:latest <...>
-    
-    # or if specifying the user:group directly
-    $ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --user "splunk-otel-collector:$(stat -c '%g' /var/run/docker.sock)" quay.io/signalfx/splunk-otel-collector:latest <...>
-
-Use auto discovery with containers 
---------------------------------------------------------------------
-
-If your Collector instance is running in a Docker container and the discovery targets are also containers, you need to share the Docker socket when launching the Collector container:
-
-.. code-block:: bash
-
-  $ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add <socket_gid>
-
-To use host bindings, run this command:
-
-.. code-block:: bash
-
-  --set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true
-
 .. _otel-installer-options-linux:
 
 Options of the installer script of the Collector for Linux
diff --git a/gdi/opentelemetry/collector-linux/linux-config.rst b/gdi/opentelemetry/collector-linux/linux-config.rst
@@ -29,3 +29,43 @@ You can view the ``splunk-otel-collector`` service logs and errors in the system
   sudo journalctl -u splunk-otel-collector   
 
 .. note:: See :ref:`about-collector-configuration-tutorial` to learn how to configure the Collector.
+
+.. _collector-linux-with-docker:
+
+Collector for Linux with Docker
+====================================================================
+
+Install the Collector in a host with Docker
+--------------------------------------------------------------------
+
+If you're installing your Collector instance in a host with Docker, you need to configure a client to establish a connection with the daemon. Depending on your Docker installation and Collector deployment method, try one of these options:
+
+1. If your daemon is listening to a domain socket (for example ``/var/run/docker.sock``), your Collector service or executable needs appropriate permissions and access. Add the ``splunk-otel-collector`` user to the Docker group as configured on your system:
+
+  .. code-block:: bash
+
+    $ usermod -aG docker splunk-otel-collector
+
+2. When using the :new-page:`quay.io/signalfx/splunk-otel-collector <https://quay.io/repository/signalfx/splunk-otel-collector>` image, add the default container user to the required group as configured on your system, and the bind and mount the domain socket:
+
+  .. code-block:: bash
+
+    $ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add $(stat -c '%g' /var/run/docker.sock) quay.io/signalfx/splunk-otel-collector:latest <...>
+    
+    # or if specifying the user:group directly
+    $ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --user "splunk-otel-collector:$(stat -c '%g' /var/run/docker.sock)" quay.io/signalfx/splunk-otel-collector:latest <...>
+
+Use auto discovery with containers 
+--------------------------------------------------------------------
+
+If your Collector instance is running in a Docker container and the discovery targets are also containers, you need to share the Docker socket when launching the Collector container:
+
+.. code-block:: bash
+
+  $ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add <socket_gid>
+
+To use host bindings, run this command:
+
+.. code-block:: bash
+
+  --set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true
diff --git a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst
@@ -28,8 +28,7 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Windows, f
 * :ref:`otel-install-windows-msi` 
 * :ref:`otel-install-windows-tools`
 * :ref:`otel-install-windows-manual`
-
-.. note:: You can also deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
+* You can also deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
 
 See the default settings and configuration options at:
 
