From 7f73920d81989f7a9f497621d358b650b9284904 Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Wed, 27 Nov 2024 15:50:11 +0100 Subject: [PATCH 01/11] AddOn and AD links --- .../collector-kubernetes/collector-kubernetes-intro.rst | 3 +++ gdi/opentelemetry/collector-linux/collector-linux-intro.rst | 2 ++ .../collector-windows/collector-windows-intro.rst | 4 ++++ 3 files changed, 9 insertions(+) diff --git a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst index 5232ec7ee..0d68db249 100644 --- a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst +++ b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst @@ -47,6 +47,7 @@ Optionally, you can also: * :ref:`otel-install-k8s-manifests` * :ref:`Deploy the Collector as an AWS EKS Add-on ` +* 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 `. @@ -66,6 +67,8 @@ To configure the Collector, including adding additional components or activating .. 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 diff --git a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst index c8ac15663..5d110fb34 100644 --- a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst +++ b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst @@ -39,6 +39,8 @@ 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`. + To upgrade or uninstall, see: * :ref:`otel-linux-upgrade` diff --git a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst index eadb93fef..0c6c1763c 100644 --- a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst +++ b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst @@ -29,6 +29,8 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Windows, f * :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`. + See the default settings and configuration options at: * :ref:`windows-config-ootb` @@ -38,6 +40,8 @@ See the default settings and configuration options at: .. include:: /_includes/gdi/collector-common-options.rst +To automatically find services and applications running in your Windows environment and send data from them to Splunk Observability Cloud refer to :ref:`discovery-windows`. + To upgrade or uninstall, see: * :ref:`otel-windows-upgrade` From fcdb9f33d38d7f0441bfd70830663a14717dc528 Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Wed, 27 Nov 2024 16:59:09 +0100 Subject: [PATCH 02/11] WIP --- .../automatic-discovery/discovery-linux.rst | 4 +- .../linux/linux-advanced-config.rst | 8 ++-- .../collector-kubernetes-intro.rst | 13 +++--- .../collector-linux/collector-linux-intro.rst | 29 ++++++++++++- .../collector-linux/install-linux.rst | 42 +------------------ .../collector-linux/linux-config.rst | 40 ++++++++++++++++++ .../collector-windows-intro.rst | 3 +- 7 files changed, 82 insertions(+), 57 deletions(-) diff --git a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst index 4021e17da..5d49dfa59 100644 --- 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. \ No newline at end of file +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`. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst index 29a8a8bb5..47a48a401 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst @@ -1,13 +1,13 @@ .. _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: @@ -15,8 +15,6 @@ Through advanced customization, you can achieve the following tasks: * :ref:`Use automatic discovery with gateway mode ` * :ref:`Customize discovery settings for third-party applications ` -.. 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 index 0d68db249..05db62b24 100644 --- a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst +++ b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst @@ -43,13 +43,13 @@ 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 `. + Optionally, you can also: * :ref:`otel-install-k8s-manifests` * :ref:`Deploy the Collector as an AWS EKS Add-on ` -* 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 `. +* 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 @@ -57,18 +57,17 @@ Optionally, you can also:

Configure the Collector for Kubernetes

-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 diff --git a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst index 5d110fb34..9f07b1d1f 100644 --- 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 + + +

Install the Collector for Linux

+ + * :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 + + +

Configure the Collector for Linux

+ + +.. 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 + + +

Upgrade, uninstall and troubleshoot

+ + 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 + + +

Tutorials

+ For a walkthrough of common tasks related to the OpenTelemetry Collector for Linux see: :ref:`about-collector-configuration-tutorial`. \ No newline at end of file diff --git a/gdi/opentelemetry/collector-linux/install-linux.rst b/gdi/opentelemetry/collector-linux/install-linux.rst index 44de84fec..7124ca4b6 100644 --- 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 ` 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 - -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 index 67ad93e7e..37594dbca 100644 --- 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 ` 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 + +To use host bindings, run this command: + +.. code-block:: bash + + --set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true \ No newline at end of file diff --git a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst index 0c6c1763c..6456ff263 100644 --- 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: From a4f41e8703a5d537816fefc9385700ecb9c84a0b Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Thu, 28 Nov 2024 10:45:54 +0100 Subject: [PATCH 03/11] WIP --- _includes/gdi/auto-discovery-intro.rst | 4 +- .../collector-linux/install-linux.rst | 42 ++++++++++++++++++- .../collector-linux/linux-config.rst | 39 ----------------- gdi/opentelemetry/discovery-mode.rst | 4 ++ 4 files changed, 47 insertions(+), 42 deletions(-) diff --git a/_includes/gdi/auto-discovery-intro.rst b/_includes/gdi/auto-discovery-intro.rst index 9130982f5..58cb2f19c 100644 --- a/_includes/gdi/auto-discovery-intro.rst +++ b/_includes/gdi/auto-discovery-intro.rst @@ -6,6 +6,6 @@ The Splunk Distribution of the OpenTelemetry Collector can automatically identif .. caution:: - Auto discovery of services is only available for the Collector in Linux and Kubernetes environments. + Auto discovery of services is only available for the Collector in Linux and Kubernetes environments. See more at :ref:`discovery-mode-services`. - Zero-code instrumentation using the Collector's automatic discovery feature is only available for Java, Node.js, and .NET applications. If deployed independently from the Collector, zero-code instrumentation is supported for 8 back-end language runtimes. For more information, see :ref:`get-started-application`. \ No newline at end of file + Zero-code instrumentation using the Collector's automatic discovery feature is only available for Java, Node.js, and .NET applications. See more at :ref:`discovery-mode-languages`. Alternatively you can deploy zero-code instrumentation independently from the Collector for 8 back-end language runtimes. For more information, see :ref:`get-started-application`. \ No newline at end of file diff --git a/gdi/opentelemetry/collector-linux/install-linux.rst b/gdi/opentelemetry/collector-linux/install-linux.rst index 7124ca4b6..324938427 100644 --- a/gdi/opentelemetry/collector-linux/install-linux.rst +++ b/gdi/opentelemetry/collector-linux/install-linux.rst @@ -98,12 +98,52 @@ For more information on APM instrumentation, see: * :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 ` 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 + +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 ================================================================== -The Linux installer script supports the following options for the Collector, Automatic Discovery for back-end services and Fluentd. +The Linux installer script supports the following options for the Collector, automatic discovery for back-end services and Fluentd. To display all the configuration options supported by the script, use the ``-h`` flag. diff --git a/gdi/opentelemetry/collector-linux/linux-config.rst b/gdi/opentelemetry/collector-linux/linux-config.rst index 37594dbca..e7d846ce2 100644 --- a/gdi/opentelemetry/collector-linux/linux-config.rst +++ b/gdi/opentelemetry/collector-linux/linux-config.rst @@ -30,42 +30,3 @@ You can view the ``splunk-otel-collector`` service logs and errors in the system .. 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 ` 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 - -To use host bindings, run this command: - -.. code-block:: bash - - --set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true \ No newline at end of file diff --git a/gdi/opentelemetry/discovery-mode.rst b/gdi/opentelemetry/discovery-mode.rst index 711c271a5..08b60a053 100644 --- a/gdi/opentelemetry/discovery-mode.rst +++ b/gdi/opentelemetry/discovery-mode.rst @@ -37,6 +37,8 @@ The following diagram shows how automatic discovery finds data sources:

Supported host services and applications for automatic discovery

+.. _discovery-mode-services: + Automatic discovery of third-party applications is supported in Linux and Kubernetes environments for the following services: .. list-table:: @@ -86,6 +88,8 @@ Read more:

Supported language runtimes for zero-code instrumentation

+.. _discovery-mode-languages: + Zero-code instrumentation via the Collector's automatic discovery is available for the following languages: .. list-table:: From 00df0f7992413ca3e879e5d1191c34fe7e58580b Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Thu, 28 Nov 2024 11:39:45 +0100 Subject: [PATCH 04/11] Tweaks --- _includes/gdi/auto-discovery-intro.rst | 12 ++---------- gdi/opentelemetry/discovery-mode.rst | 8 +++----- 2 files changed, 5 insertions(+), 15 deletions(-) diff --git a/_includes/gdi/auto-discovery-intro.rst b/_includes/gdi/auto-discovery-intro.rst index 58cb2f19c..b9eea6408 100644 --- a/_includes/gdi/auto-discovery-intro.rst +++ b/_includes/gdi/auto-discovery-intro.rst @@ -1,11 +1,3 @@ -The Splunk Distribution of the OpenTelemetry Collector can automatically identify data sources and collect metrics and traces to send them to Splunk Observability Cloud. With automatic discovery and zero-code instrumentation you don't need to manually configure the Splunk Distribution of the OpenTelemetry Collector or your applications before deploying them: +Automatic discovery detects and collects signal data from third-party services, such as databases and web servers. Through auto discovery the Collector automatically generates a configuration snipet that you can modify and incorporate into your existing configuration to retrieve your services' data. Auto discovery of services is only available for the Collector in Linux and Kubernetes environments. -* Automatic discovery detects and collects signal data from third-party services, such as databases and web servers. Through auto discovery the Collector automatically generates a configuration snipet that you can modify and incorporate into your existing configuration to retrieve your services' data. - -* With automatic discovery you can also enable zero-code instrumentation, which allows the Collector to retrieve data from application language runtimes without having to modify the source application code or adding any new installation or configuration steps. With this option you won't have to install and configure your instrumentation agents separately. - -.. caution:: - - Auto discovery of services is only available for the Collector in Linux and Kubernetes environments. See more at :ref:`discovery-mode-services`. - - Zero-code instrumentation using the Collector's automatic discovery feature is only available for Java, Node.js, and .NET applications. See more at :ref:`discovery-mode-languages`. Alternatively you can deploy zero-code instrumentation independently from the Collector for 8 back-end language runtimes. For more information, see :ref:`get-started-application`. \ No newline at end of file +With automatic discovery you can also enable zero-code instrumentation of back-end applications, which allows the Collector to retrieve data from application language runtimes without having to modify the source application code or adding any new installation or configuration steps. With this option you won't have to install and configure your instrumentation agents separately. Zero-code instrumentation using the Collector's automatic discovery feature is only available for the Java, Node.js, and .NET language runtimes. Alternatively you can deploy zero-code instrumentation independently from the Collector for 8 back-end languages, as described in :ref:`get-started-application`. \ No newline at end of file diff --git a/gdi/opentelemetry/discovery-mode.rst b/gdi/opentelemetry/discovery-mode.rst index 08b60a053..ad67b1ba8 100644 --- a/gdi/opentelemetry/discovery-mode.rst +++ b/gdi/opentelemetry/discovery-mode.rst @@ -14,7 +14,7 @@ Automatic discovery of apps and services Linux Windows -.. include:: /_includes/gdi/auto-discovery-intro.rst +The Splunk Distribution of the OpenTelemetry Collector can automatically identify data sources and collect metrics and traces to send them to Splunk Observability Cloud. With automatic discovery and zero-code instrumentation you don't need to manually configure the Splunk Distribution of the OpenTelemetry Collector or your applications before deploying them. The following diagram shows how automatic discovery finds data sources: @@ -33,12 +33,12 @@ The following diagram shows how automatic discovery finds data sources: X --> Y --> Z +.. include:: /_includes/gdi/auto-discovery-intro.rst + .. raw:: html

Supported host services and applications for automatic discovery

-.. _discovery-mode-services: - Automatic discovery of third-party applications is supported in Linux and Kubernetes environments for the following services: .. list-table:: @@ -88,8 +88,6 @@ Read more:

Supported language runtimes for zero-code instrumentation

-.. _discovery-mode-languages: - Zero-code instrumentation via the Collector's automatic discovery is available for the following languages: .. list-table:: From 8e47fa0cf0cdff3900e885fc990f44610afc356b Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Thu, 28 Nov 2024 11:45:13 +0100 Subject: [PATCH 05/11] Minor edits --- .../collector-kubernetes-intro.rst | 6 +++--- .../collector-linux/collector-linux-intro.rst | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst index 05db62b24..644e2921a 100644 --- a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst +++ b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst @@ -37,13 +37,13 @@ To install, configure and use the Splunk Distribution of the Collector for Kuber

Install the Collector for Kubernetes

-To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using the Helm chart, read and follow these docs: +To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using the Helm chart read and follow these docs: * :ref:`otel-install-k8s` * :ref:`kubernetes-helm-architecture` * :ref:`kubernetes-helm-releases` -.. note:: By default, you'll obtain these :ref:`Kubernetes metrics `. +.. note:: By default you'll obtain these :ref:`Kubernetes metrics `. Optionally, you can also: @@ -74,7 +74,7 @@ To configure the Collector see:

Upgrade, uninstall and troubleshoot

-To upgrade or uninstall, see: +To upgrade or uninstall the Collector see: * :ref:`otel-kubernetes-upgrade` * :ref:`otel-kubernetes-uninstall` diff --git a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst index 9f07b1d1f..46d371137 100644 --- a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst +++ b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst @@ -30,11 +30,12 @@ To install and configure the Splunk Distribution of the OpenTelemetry Collector

Install the Collector for Linux

+To install the Splunk Distribution of the OpenTelemetry Collector for Linux you have the following options: + * :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`. +* 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 @@ -59,13 +60,12 @@ See the default settings and configuration options at:

Upgrade, uninstall and troubleshoot

- -To upgrade or uninstall, see: +To upgrade or uninstall the Collector see: * :ref:`otel-linux-upgrade` * :ref:`otel-linux-uninstall` -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 From bab6e66a34c8a523b7f566d358d5a9ffb1851c11 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 28 Nov 2024 12:53:58 +0100 Subject: [PATCH 06/11] Minor update to topic name --- data-visualization/dashboards/dashboard-basics.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/data-visualization/dashboards/dashboard-basics.rst b/data-visualization/dashboards/dashboard-basics.rst index 160f57557..ce8e5052b 100644 --- a/data-visualization/dashboards/dashboard-basics.rst +++ b/data-visualization/dashboards/dashboard-basics.rst @@ -1,13 +1,13 @@ .. _dashboard-basics: -************************************************ -Dashboard types in Splunk Observability Cloud -************************************************ +************************************************************************* +Dashboard and dashboard group types in Splunk Observability Cloud +************************************************************************* .. meta:: - :description: Use built-in, custom, or user dashboard types to understand your data in Splunk Observability Cloud. Custom and user dashboards and dashboard groups are accessible by all users. + :description: Use built-in, custom, or user dashboard and dashboard group types to understand your data in Splunk Observability Cloud. Custom and user dashboards and dashboard groups are accessible by all users. -Dashboards are groupings of charts and visualizations of metrics. All dashboards, irrespective of type, belong to a dashboard group. Dashboard groups are displayed on the Dashboards page. +Dashboards are groupings of charts and visualizations of metrics. All dashboards, irrespective of type, belong to a dashboard group. Dashboard groups are displayed on the :strong:`Dashboards` page. For more information about accessing dashboards and dashboard groups, see :ref:`viewing-dashboards`. From 9a62bcebf7361a594f4c3752a4c50cf1351a6169 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 28 Nov 2024 13:30:43 +0100 Subject: [PATCH 07/11] Style fixes --- data-visualization/dashboards/dashboard-basics.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/data-visualization/dashboards/dashboard-basics.rst b/data-visualization/dashboards/dashboard-basics.rst index ce8e5052b..58ebb7106 100644 --- a/data-visualization/dashboards/dashboard-basics.rst +++ b/data-visualization/dashboards/dashboard-basics.rst @@ -30,9 +30,9 @@ Built-in dashboards and dashboard groups .. how to handle "collectd" reference here? okay as-is? -Built-in dashboard groups are provided to give you immediate visibility into the technologies and services being used in your environment. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Most of the collectd plugins that we support come with built-in dashboard groups, as do many Amazon Web Services and Google Cloud Platform services. +Built-in dashboard groups are provided to give you immediate visibility into the technologies and services being used in your environment. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Most of the supported collectd plugins come with built-in dashboard groups, as do many Amazon Web Services and Google Cloud Platform services. -Built-in dashboards are meant to behave like templates. To make use of them in any way beyond simple viewing, for example to add or modify charts, you must first save a copy of the dashboard by opening the :strong:`Dashboard actions` menu and clicking :strong:`Save as`. For more information about built-in dashboards, see :ref:`built-in-dashboards`. +Built-in dashboards behave like templates. To make use of them in any way beyond simple viewing, for example to add or modify charts, you must first save a copy of the dashboard by opening the :strong:`Dashboard actions` menu and clicking :strong:`Save as`. For more information about built-in dashboards, see :ref:`built-in-dashboards`. .. still need to migrate this content? @@ -54,8 +54,8 @@ Custom dashboards are meant to be used by multiple people and usually represent User dashboards and dashboard groups ======================================= -Every Splunk Observability Cloud user who has set a password and logged in at least once, gets a user dashboard group and user dashboard. Your user dashboard group is your individual workspace within Splunk Observability Cloud. Depending on when your user was created, your user dashboard group may contain a large number of demo data dashboards. +Every Splunk Observability Cloud user who has set a password and logged in at least once, gets a user dashboard group and user dashboard. Your user dashboard group is your individual workspace within Splunk Observability Cloud. Depending on when your user was created, your user dashboard group might contain a large number of demo data dashboards. -The names of your user dashboard group and user dashboard are the the email address associated with your Splunk Observability Cloud account. +The names of your user dashboard group and user dashboard are the email address associated with your Splunk Observability Cloud account. -To access your user dashboard group, in the navigation menu, click :strong:`Dashboards`. At the top of the Dashboards page, you'll see your favorite dashboards, recently accessed dashboards, and your user dashboard in your user dashboard group. +To access your user dashboard group, in the navigation menu, select :strong:`Dashboards`. At the top of the :strong:`Dashboards` page, you can see your favorite dashboards, recently accessed dashboards, and your user dashboard in your user dashboard group. From 48a3ffc8747c320d754156e5a84bb67de5138870 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 28 Nov 2024 13:31:09 +0100 Subject: [PATCH 08/11] Style fixes --- data-visualization/dashboards/dashboard-basics.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data-visualization/dashboards/dashboard-basics.rst b/data-visualization/dashboards/dashboard-basics.rst index 58ebb7106..9c6681f65 100644 --- a/data-visualization/dashboards/dashboard-basics.rst +++ b/data-visualization/dashboards/dashboard-basics.rst @@ -30,7 +30,7 @@ Built-in dashboards and dashboard groups .. how to handle "collectd" reference here? okay as-is? -Built-in dashboard groups are provided to give you immediate visibility into the technologies and services being used in your environment. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Most of the supported collectd plugins come with built-in dashboard groups, as do many Amazon Web Services and Google Cloud Platform services. +Built-in dashboard groups are provided to give you immediate visibility into the technologies and services used in your environment. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Most of the supported collectd plugins come with built-in dashboard groups, as do many Amazon Web Services and Google Cloud Platform services. Built-in dashboards behave like templates. To make use of them in any way beyond simple viewing, for example to add or modify charts, you must first save a copy of the dashboard by opening the :strong:`Dashboard actions` menu and clicking :strong:`Save as`. For more information about built-in dashboards, see :ref:`built-in-dashboards`. From b4f31e547d761cd12371d4e5c4edba12daff3ca4 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 28 Nov 2024 13:33:56 +0100 Subject: [PATCH 09/11] Formatting --- data-visualization/dashboards/dashboard-basics.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/data-visualization/dashboards/dashboard-basics.rst b/data-visualization/dashboards/dashboard-basics.rst index 9c6681f65..ef654e28b 100644 --- a/data-visualization/dashboards/dashboard-basics.rst +++ b/data-visualization/dashboards/dashboard-basics.rst @@ -32,7 +32,12 @@ Built-in dashboards and dashboard groups Built-in dashboard groups are provided to give you immediate visibility into the technologies and services used in your environment. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Most of the supported collectd plugins come with built-in dashboard groups, as do many Amazon Web Services and Google Cloud Platform services. -Built-in dashboards behave like templates. To make use of them in any way beyond simple viewing, for example to add or modify charts, you must first save a copy of the dashboard by opening the :strong:`Dashboard actions` menu and clicking :strong:`Save as`. For more information about built-in dashboards, see :ref:`built-in-dashboards`. +Built-in dashboards behave like templates. To use them in any way beyond simple viewing, for example to add or modify charts, you must first save a copy of the dashboard by following these steps: + +#. Select the :strong:`Dashboard actions` menu. +#. Select :strong:`Save as`. + +For more information about built-in dashboards, see :ref:`built-in-dashboards`. For the full list of available built-in dashboards, see :ref:`dashboards-list-imm`. .. still need to migrate this content? From af3e91e9749e2b462f1d0dd1da1ea172c2e986f9 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 28 Nov 2024 14:20:08 +0100 Subject: [PATCH 10/11] More style fixes --- .../dashboards/dashboard-basics.rst | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/data-visualization/dashboards/dashboard-basics.rst b/data-visualization/dashboards/dashboard-basics.rst index ef654e28b..0358361ac 100644 --- a/data-visualization/dashboards/dashboard-basics.rst +++ b/data-visualization/dashboards/dashboard-basics.rst @@ -7,7 +7,7 @@ Dashboard and dashboard group types in Splunk Observability Cloud .. meta:: :description: Use built-in, custom, or user dashboard and dashboard group types to understand your data in Splunk Observability Cloud. Custom and user dashboards and dashboard groups are accessible by all users. -Dashboards are groupings of charts and visualizations of metrics. All dashboards, irrespective of type, belong to a dashboard group. Dashboard groups are displayed on the :strong:`Dashboards` page. +Dashboards are groupings of charts and visualizations of metrics. All dashboards, irrespective of type, belong to a dashboard group. Dashboard groups appear on the :strong:`Dashboards` page. For more information about accessing dashboards and dashboard groups, see :ref:`viewing-dashboards`. @@ -27,10 +27,7 @@ All custom and user dashboards and dashboard groups are accessible by all users Built-in dashboards and dashboard groups =========================================== -.. - how to handle "collectd" reference here? okay as-is? - -Built-in dashboard groups are provided to give you immediate visibility into the technologies and services used in your environment. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Most of the supported collectd plugins come with built-in dashboard groups, as do many Amazon Web Services and Google Cloud Platform services. +Splunk Observability Cloud creates built-in dashboard groups when you add a data-monitoring integration. The dashboards in these groups are automatically created for you when you use integrations that send metrics that Splunk Observability Cloud recognizes. Built-in dashboard groups give you immediate visibility into the technologies and services used in your environment. Built-in dashboards behave like templates. To use them in any way beyond simple viewing, for example to add or modify charts, you must first save a copy of the dashboard by following these steps: @@ -39,19 +36,15 @@ Built-in dashboards behave like templates. To use them in any way beyond simple For more information about built-in dashboards, see :ref:`built-in-dashboards`. For the full list of available built-in dashboards, see :ref:`dashboards-list-imm`. -.. - still need to migrate this content? - Custom dashboards and dashboard groups ========================================= -.. - ref broken for now bc page that includes the label is also in the process of being migrated. resolve once both pages are merged to trangl-POR-7413-migrate-custom-content. +Custom dashboard groups and custom dashboards are ones that aren't automatically generated by Splunk Observability Cloud. For example, when you create a new dashboard group, you are creating a custom dashboard group. -Custom dashboard groups and custom dashboards are ones that aren't automatically generated by Splunk Observability Cloud. For example, when you create a new dashboard group, you are creating a custom dashboard group. For more information about creating dashboard groups and dashboards, see :ref:`create-dashboard`. +Multiple users can work on a custom dashboard to represent a curated set of charts that they want to make accessible to a broad cross-section of the organization. Custom dashboards are typically organized by service, team, or environment. -Custom dashboards are meant to be used by multiple people and usually represent a curated set of charts that you want to make accessible to a broad cross-section of your organization. They are typically organized by service, team, or environment. +For more information about creating dashboard groups and dashboards, see :ref:`create-dashboard`. .. _user-dashboard-group: @@ -59,7 +52,7 @@ Custom dashboards are meant to be used by multiple people and usually represent User dashboards and dashboard groups ======================================= -Every Splunk Observability Cloud user who has set a password and logged in at least once, gets a user dashboard group and user dashboard. Your user dashboard group is your individual workspace within Splunk Observability Cloud. Depending on when your user was created, your user dashboard group might contain a large number of demo data dashboards. +Every Splunk Observability Cloud user who has set a password and logged in at least once, gets a user dashboard group and user dashboard. Your user dashboard group is your individual workspace within Splunk Observability Cloud. Depending on when you create your account, your user dashboard group might contain a large number of demo data dashboards. The names of your user dashboard group and user dashboard are the email address associated with your Splunk Observability Cloud account. From 1d80f9541a63017f421074460427afe1dce9ff39 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 28 Nov 2024 14:20:27 +0100 Subject: [PATCH 11/11] Remove comma --- data-visualization/dashboards/dashboard-basics.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data-visualization/dashboards/dashboard-basics.rst b/data-visualization/dashboards/dashboard-basics.rst index 0358361ac..1cc48aa81 100644 --- a/data-visualization/dashboards/dashboard-basics.rst +++ b/data-visualization/dashboards/dashboard-basics.rst @@ -52,7 +52,7 @@ For more information about creating dashboard groups and dashboards, see :ref:`c User dashboards and dashboard groups ======================================= -Every Splunk Observability Cloud user who has set a password and logged in at least once, gets a user dashboard group and user dashboard. Your user dashboard group is your individual workspace within Splunk Observability Cloud. Depending on when you create your account, your user dashboard group might contain a large number of demo data dashboards. +Every Splunk Observability Cloud user who has set a password and logged in at least once gets a user dashboard group and user dashboard. Your user dashboard group is your individual workspace within Splunk Observability Cloud. Depending on when you create your account, your user dashboard group might contain a large number of demo data dashboards. The names of your user dashboard group and user dashboard are the email address associated with your Splunk Observability Cloud account.