diff --git a/_includes/gdi/auto-discovery-intro.rst b/_includes/gdi/auto-discovery-intro.rst new file mode 100644 index 000000000..9130982f5 --- /dev/null +++ b/_includes/gdi/auto-discovery-intro.rst @@ -0,0 +1,11 @@ +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. + +* 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. + + 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 diff --git a/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst b/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst index 21d82d366..f77c05c3f 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst @@ -1,11 +1,11 @@ .. _discovery-kubernetes: ************************************************************************ -Automatic discovery and configuration for Kubernetes +Automatic discovery for Kubernetes ************************************************************************ .. meta:: - :description: Get started with automatic discovery and configuration for Kubernetes environments. Deploy automatic discovery to automatically find applications running in your environment and send data from them to Splunk Observability Cloud. + :description: Get started with automatic discovery and instrumentation for Kubernetes environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your environment and send data from them to Splunk Observability Cloud. .. toctree:: :hidden: @@ -15,18 +15,14 @@ Automatic discovery and configuration for Kubernetes Advanced customization k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial -Automatic discovery and configuration for Kubernetes automatically finds applications running in your Kubernetes environments and captures telemetry data from them. The Splunk Distribution of OpenTelemetry Collector receives this data and sends it to Splunk Observability Cloud. - -Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them. +.. include:: /_includes/gdi/auto-discovery-intro.rst .. raw:: html

Get started

-Automatic discovery for Kubernetes supports both back-end applications (such as Java and Node.js) as well as third-party applications (such as databases and web servers). - -To use automatic discovery for back-end applications, see :ref:`k8s-backend-auto-discovery`. +To enable the Collector's zero-code instrumentation of back-end applications written in Java, Node.js, and .NET see :ref:`k8s-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately. -To use automatic discovery with third-party applications, see :ref:`k8s-third-party`. +To use the Collector's automatic discovery of third-party applications in Kubernetes environments see :ref:`k8s-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector. -For a walkthrough of how to use automatic discovery to instrument an application in a Kubernetees environment, see :ref:`k8s-advanced-auto-discovery-config`. \ No newline at end of file +For a walkthrough of how to use automatic instrumentation to instrument an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst index a72f4549d..4021e17da 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst @@ -1,11 +1,11 @@ .. _discovery-linux: ************************************************************************ -Automatic discovery and configuration for Linux +Automatic discovery for Linux ************************************************************************ .. meta:: - :description: Get started with automatic discovery and configuration for Linux environments. Deploy automatic discovery to automatically find applications running in your Linux environment and send data from them to Splunk Observability Cloud. + :description: Get started with automatic discovery and instrumentation for Linux environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud. .. toctree:: :hidden: @@ -14,16 +14,12 @@ Automatic discovery and configuration for Linux Third-party applications Advanced customization -Automatic discovery and configuration for Linux automatically finds applications running in your Linux environment and captures telemetry data from them. The Splunk Distribution of OpenTelemetry Collector receives this data and sends it to Splunk Observability Cloud. - -Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them. +.. include:: /_includes/gdi/auto-discovery-intro.rst .. raw:: html

Get started

-Automatic discovery for Linux supports both back-end applications (such as Java and Node.js) as well as third-party applications (such as databases, web servers, and message queues). - -To use automatic discovery for back-end applications, see :ref:`linux-backend-auto-discovery`. +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 automatic discovery with third-party applications, see :ref:`linux-third-party`. \ 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. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst index 7bfe2851b..5259a44ce 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst @@ -1,25 +1,23 @@ .. _discovery-windows: ************************************************************************ -Automatic discovery and configuration for Windows +Automatic discovery for Windows ************************************************************************ .. meta:: - :description: Get started with automatic discovery and configuration for Windows environments. Deploy automatic discovery to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud. + :description: Get started with automatic instrumentation for Windows environments. Deploy automatic instrumentation to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud. .. toctree:: :hidden: Language runtimes -Automatic discovery and configuration for Windows automatically finds applications running in your Windows environment and captures telemetry data from them. The Splunk Distribution of OpenTelemetry Collector receives this data and sends it to Splunk Observability Cloud. - -Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them. +.. include:: /_includes/gdi/auto-discovery-intro.rst .. raw:: html

Get started

-Automatic discovery for Windows supports .NET language runtimes. +The Collector for Windows does not support automatic discovery of services. -To use automatic discovery for back-end applications, see :ref:`windows-backend-auto-discovery`. \ No newline at end of file +To enable the Collector's zero-code instrumentation of back-end applications written in .NET see :ref:`windows-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-advanced-config.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-advanced-config.rst index eff55f60d..596425e8b 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-advanced-config.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-advanced-config.rst @@ -1,13 +1,13 @@ .. _k8s-advanced-auto-discovery-config: -*********************************************************************** -Advanced customization for automatic discovery in Kubernetes -*********************************************************************** +******************************************************************************** +Advanced customization for automatic discovery and instrumtenation in Kubernetes +******************************************************************************** .. meta:: - :description: Learn how to customize your deployment of automatic discovery in a Kubernetes environment. + :description: Learn how to customize your deployment of automatic discovery and instrumentation in a Kubernetes environment. -Learn how to customize Splunk automatic discovery and configuration for advanced scenarios. +Learn how to customize Splunk automatic discovery and instrumentation for advanced scenarios. Through advanced customization, you can achieve the following tasks: @@ -45,7 +45,7 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v repository: ghcr.io/signalfx/splunk-otel-java/splunk-otel-java tag: v1.27.0 -#. Reinstall the Splunk OTel Collector Chart with the following command. Replace with the current version of your splunk-otel-collector-chart. +#. Reinstall the Splunk OTel Collector chart with the following command. Replace with the current version of your splunk-otel-collector-chart. .. code-block:: bash @@ -94,7 +94,7 @@ Follow these steps to activate Profiling for a language: - name: SPLUNK_PROFILER_CALL_STACK_INTERVAL value: 5000 -#. Reinstall the Splunk OTel Collector Chart with the following command. Replace with the current version of your splunk-otel-collector-chart. +#. Reinstall the Splunk OTel Collector chart with the following command. Replace with the current version of your splunk-otel-collector-chart. .. code-block:: bash @@ -103,7 +103,7 @@ Follow these steps to activate Profiling for a language: Activate runtime metrics collection (Java and Node.js only) ------------------------------------------------------------- -You can activate runtime metrics collection for Java and Node.js applications running in your Kubernetes environment. To learn more about runtime metrics collection, see : +You can activate runtime metrics collection for Java and Node.js applications running in your Kubernetes environment. Follow these steps to activate runtime metrics collection: @@ -139,7 +139,7 @@ Follow these steps to activate runtime metrics collection: - name: SPLUNK_METRICS_ENDPOINT value: http://$(SPLUNK_OTEL_AGENT):9943/v2/datapoint -#. Reinstall the Splunk OTel Collector Chart with the following command. Replace with the current version of your splunk-otel-collector-chart. +#. Reinstall the Splunk OTel Collector chart with the following command. Replace with the current version of your splunk-otel-collector-chart. .. code-block:: bash @@ -150,7 +150,7 @@ Follow these steps to activate runtime metrics collection: Use automatic discovery with gateway mode ======================================================= -The Splunk OTel Collector Chart uses the agent mode by default. Activating gateway mode deploys an instance of the OpenTelemetry Collector in a separate container, and this instance collects data from the entire cluster. +The Splunk OTel Collector chart uses the agent mode by default. Activating gateway mode deploys an instance of the OpenTelemetry Collector in a separate container, and this instance collects data from the entire cluster. To learn more about the gateway mode, see :ref:`collector-gateway-mode`. @@ -176,7 +176,7 @@ Follow these steps to send data to a gateway endpoint: exporter: endpoint: -#. Reinstall the Splunk OTel Collector Chart with the following command. Replace with the current version of your splunk-otel-collector-chart. +#. Reinstall the Splunk OTel Collector chart with the following command. Replace with the current version of your splunk-otel-collector-chart. .. code-block:: bash @@ -207,7 +207,7 @@ Using this configuration, automatic discovery automatically sends data to a runn Additional settings =================================== -There are many other settings you can customize in automatic discovery and configuration. +There are many other settings you can customize in automatic instrumentation. For a list of settings that you can change for each language, see the following resources: diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst index c113ab4b3..165fd26f2 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst @@ -1,33 +1,33 @@ .. _k8s-backend-auto-discovery: ******************************************************************************** -Automatic discovery and configuration for back-end applications in Kubernetes +Automatic instrumentation for back-end applications in Kubernetes ******************************************************************************** .. meta:: - :description: Get started with automatic discovery and configuration for back-end applications and language runtimes in a Kubernetes environment. + :description: Get started with automatic instrumentation for back-end applications and language runtimes in a Kubernetes environment. -When using automatic discovery and configuration, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Kubernetes environment. +When using automatic instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Kubernetes environment. -By deploying the Collector with automatic discovery, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. +By deploying the Collector with automatic instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. -Automatic discovery for Kubernetes can detect and configure the following applications and language runtimes: +Automatic instrumentation for Kubernetes can detect and configure the following applications and language runtimes: * Java * .NET * Node.js -How automatic discovery for Kubernetes works -================================================ +How automatic instrumentation for Kubernetes works +================================================== -Automatic discovery for Kubernetes operates as a Kubernetes DaemonSet that you install with Helm. Using Helm, you can specify which language runtimes you want automatic discovery to find. After installation, Helm deploys a set of Kubernetes pods in your cluster, which includes the Splunk Distribution of OpenTelemetry Collector, the Kubernetes operator, and other supporting resources. +Automatic instrumentation for Kubernetes operates as a Kubernetes DaemonSet that you install with Helm. Using Helm, you can specify which language runtimes you want automatic instrumentation to find. After installation, Helm deploys a set of Kubernetes pods in your cluster, which includes the Splunk Distribution of OpenTelemetry Collector, the Kubernetes operator, and other supporting resources. The Collector and Kubernetes operator listen for requests to your application and gather telemetry data upon detecting activity in your application. The Collector then sends this data to Splunk Application Performance Monitoring (APM). Get started ============================== -To install automatic discovery for Kubernetes, complete the following steps: +To install automatic instrumentation for Kubernetes, complete the following steps: #. :ref:`k8s-auto-discovery-deploy-helm-chart` #. :ref:`k8s-auto-discovery-verify-resources` @@ -39,7 +39,7 @@ To install automatic discovery for Kubernetes, complete the following steps: Requirements =============================================== -You need the following components to use automatic discovery for back-end Kubernetes applications: +You need the following components to use automatic instrumentation for back-end Kubernetes applications: * Helm version 3 or higher. * Administrator access to your Kubernetes cluster and familiarity with your Kubernetes configuration. @@ -297,7 +297,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-java-app image: my-java-app:latest - Activate automatic discovery by adding ``instrumentation.opentelemetry.io/inject-java: "true"`` to the ``spec``: + Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/inject-java: "true"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10 @@ -359,7 +359,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-dotnet-app image: my-dotnet-app:latest - Activate automatic discovery by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: + Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10,11 @@ -398,7 +398,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-dotnet-app image: my-dotnet-app:latest - Activate automatic discovery by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-musl-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: + Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-musl-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10,11 @@ -439,7 +439,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-nodejs-app image: my-nodejs-app:latest - Activate automatic discovery by adding ``instrumentation.opentelemetry.io/inject-nodejs: "true"`` to the ``spec``: + Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/inject-nodejs: "true"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10 @@ -475,7 +475,7 @@ Replace ```` with the language of the application you want Instrument applications in multi-container pods ------------------------------------------------- -By default, automatic discovery instruments the first container in the Kubernetes pod spec. You can specify multiple containers to instrument by adding an annotation. +By default, automatic instrumentation instruments the first container in the Kubernetes pod spec. You can specify multiple containers to instrument by adding an annotation. The following example instruments Java applications running in the ``myapp`` and ``myapp2`` containers: @@ -521,16 +521,16 @@ You can also instrument multiple containers with specific languages. To do so, s instrumentation.opentelemetry.io/inject-nodejs: "true" instrumentation.opentelemetry.io/python-container-names: "myapp3" -Deactivate automatic discovery +Deactivate automatic instrumentation ----------------------------------------------- -To deactivate automatic discovery, remove the annotation. The following command removes the annotation for automatic discovery, deactivating it: +To deactivate automatic instrumentation, remove the annotation. The following command removes the annotation for automatic instrumentation, deactivating it: .. code-block:: bash kubectl patch deployment -n --type=json -p='[{"op": "remove", "path": "/spec/template/metadata/annotations/instrumentation.opentelemetry.io~1inject-"}]' -Replace ```` with the language of the application for which you want to deactivate discovery. +Replace ```` with the language of the application for which you want to deactivate instrumentation. Verify instrumentation ---------------------------------------- @@ -625,5 +625,5 @@ To troubleshoot common errors that occur when instrumenting applications, see th Learn more =========================================================================== -* To learn more about how automatic discovery and configuration works in Splunk Observability Cloud, see :new-page:`more detailed documentation in GitHub `. +* To learn more about how automatic instrumentation works in Splunk Observability Cloud, see :new-page:`more detailed documentation in GitHub `. * See :new-page:`the operator pattern in the Kubernetes documentation ` for more information. diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial.rst index b1d6085e0..0b7ef976b 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial.rst @@ -5,7 +5,7 @@ Tutorial: Capture traces from a Java application in Kubernetes ******************************************************************************* .. meta:: - :description: Learn how to capture traces from a Java application in Kubernetes using Splunk automatic discovery and configuration. + :description: Learn how to capture traces from a Java application in Kubernetes using Splunk automatic instrumentation. .. toctree:: :hidden: @@ -15,7 +15,7 @@ Tutorial: Capture traces from a Java application in Kubernetes deploy-collector-k8s-java.rst k8s-java-view-apm.rst -Follow this tutorial for a walkthrough of instrumenting a sample Java application in a Kubernetes environment by using Splunk automatic discovery and configuration (formerly Zero Configuration Auto Instrumentation). +Follow this tutorial for a walkthrough of instrumenting a sample Java application in a Kubernetes environment by using Splunk automatic instrumentation (formerly Zero Configuration Auto Instrumentation). .. raw:: html diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/k8s-java-view-apm.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/k8s-java-view-apm.rst index 2e4636ec2..fb64b1209 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/k8s-java-view-apm.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/k8s-java-view-apm.rst @@ -35,4 +35,4 @@ Learn more See :ref:`get-started-apm` to learn how to use Splunk APM to gather insights about your data. -See :ref:`discovery_mode` for more information about automatic discovery. +See :ref:`discovery_mode` for more information about automatic discovery and automatic instrumentation. diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-third-party.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-third-party.rst index f81599b5e..bdb2d822f 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-third-party.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-third-party.rst @@ -1,13 +1,13 @@ .. _k8s-third-party: *************************************************************************************** -Automatic discovery and configuration for third-party applications in Kubernetes +Automatic discovery for third-party services in Kubernetes *************************************************************************************** .. meta:: - :description: Learn how to use automatic discovery and configuration to send data from your third-party applications in Kubernetes to Splunk Observability Cloud. + :description: Learn how to use automatic discovery to send data from your third-party applications in Kubernetes to Splunk Observability Cloud. -You can use automatic discovery and configuration to find third-party applications (such as databases and web servers) running in your Kubernetes environment. Automatic discovery gathers telemetry data from these applications and sends it to Splunk Observability Cloud. +You can use automatic discovery to find third-party applications (such as databases and web servers) running in your Kubernetes environment. Automatic discovery gathers telemetry data from these applications and sends it to Splunk Observability Cloud. .. note:: Update the Collector to version 0.94.0 and higher to activate automatic service discovery. diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst index 8646f351e..29a8a8bb5 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst @@ -1,17 +1,17 @@ .. _linux-advanced-auto-discovery-config: ***************************************************************************** -Advanced customization for automatic discovery in Linux +Advanced customization for automatic discovery and instrumentation in Linux ***************************************************************************** .. meta:: - :description: Learn how to customize your deployment of automatic discovery in a Linux environment. + :description: Learn how to customize your deployment of automatic discovery and instrumentation in a Linux environment. -Learn how to customize automatic discovery and configuration for advanced scenarios. +Learn how to customize automatic discovery and instrumentation for advanced scenarios. Through advanced customization, you can achieve the following tasks: -* :ref:`Override automatic discovery settings ` +* :ref:`Override automatic instrumentation settings ` * :ref:`Use automatic discovery with gateway mode ` * :ref:`Customize discovery settings for third-party applications ` @@ -19,10 +19,10 @@ Through advanced customization, you can achieve the following tasks: .. _override-default-settings-linux: -Override default automatic discovery settings +Override default automatic instrumentation settings ===================================================== -You can override default automatic discovery settings to use features for profiling and runtime metrics collection. +You can override default automatic instrumentation settings to use features for profiling and runtime metrics collection. Activate AlwaysOn Profiling -------------------------------------- @@ -175,7 +175,7 @@ To define a custom directory for discovery settings, use the ``--config-dir`` op Additional settings for language runtimes ============================================= -There are many other settings you can customize using automatic discovery and configuration. +There are many other settings you can customize using automatic instrumentation. For a list of settings that you can change for each language, see the following resources: diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst index d9460f3c2..db9463889 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst @@ -1,33 +1,33 @@ .. _linux-backend-auto-discovery: ***************************************************************************** -Automatic discovery and configuration for back-end applications in Linux +Automatic instrumentation for back-end applications in Linux ***************************************************************************** .. meta:: - :description: Get started with automatic discovery and configuration for back-end applications in Linux environments. + :description: Get started with automatic instrumentation for back-end applications in Linux environments. -When using automatic discovery and configuration, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Linux environment. +When using automatic instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Linux environment. -By deploying the Collector with automatic discovery, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. +By deploying the Collector with automatic instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. -Automatic discovery for Linux can detect and configure the following applications and language runtimes: +Automatic instrumentation for Linux can detect and configure the following applications and language runtimes: * Java * Node.js * .NET -How automatic discovery for Linux works +How automatic instrumentation for Linux works =================================================== -Automatic discovery for Linux operates as a mode of the Splunk Distribution of OpenTelemetry Collector. You install and activate automatic discovery for the Collector by using the Linux installer script or package manager. During installation, you can specify the types of language runtimes you want the Collector to detect. +Automatic instrumentation for Linux operates as a mode of the Splunk Distribution of OpenTelemetry Collector. You install and activate automatic instrumentation for the Collector by using the Linux installer script or package manager. During installation, you can specify the types of language runtimes you want the Collector to detect. After installation, the Collector runs in your Linux environment and listens for requests to your applications. When the Collector detects activity, it gathers telemetry data from your application runtime and sends this data to Splunk Application Performance Monitoring (APM). Requirements ================================================== -You need the following components to use automatic discovery for back-end Linux applications: +You need the following components to use automatic instrumentation for back-end Linux applications: * ``systemd`` * ``curl`` @@ -49,12 +49,12 @@ Make sure you've also installed the components specific to your language runtime .NET version 6.0 or higher and supported libraries. See :ref:`dotnet-otel-requirements` for more information. - Automatic discovery for .NET is only supported for x86_64/AMD64 architectures. + Automatic instrumentation for .NET is only supported for x86_64/AMD64 architectures. Get started =============================== -To install and use automatic discovery for Linux, follow these steps: +To install and use automatic instrumentation for Linux, follow these steps: #. :ref:`auto-discovery-linux-install` #. :ref:`auto-discovery-linux-verify` @@ -65,7 +65,7 @@ To install and use automatic discovery for Linux, follow these steps: Install the package ======================================= -Using the installer script, you can install and activate automatic discovery for either all supported applications on the host via the system-wide method or only for applications running as ``systemd`` services. +Using the installer script, you can install and activate automatic instrumentation for either all supported applications on the host via the system-wide method or only for applications running as ``systemd`` services. .. tabs:: @@ -76,9 +76,9 @@ Using the installer script, you can install and activate automatic discovery for .. tab:: Installer script - Using the installer script, you can install the automatic discovery package for Java and activate automatic discovery for Java for either all supported Java applications on the host via the system-wide method or for only Java applications running as ``systemd`` services. + Using the installer script, you can install the automatic instrumentation package for Java and activate automatic instrumentation for Java for either all supported Java applications on the host via the system-wide method or for only Java applications running as ``systemd`` services. - .. note:: By default, automatic discovery is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic discovery for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. + .. note:: By default, automatic instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. .. tabs:: @@ -93,7 +93,7 @@ Using the installer script, you can install and activate automatic discovery for .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - The system-wide automatic discovery method automatically adds environment variables to ``/etc/splunk/zeroconfig/java.conf``. + The system-wide automatic instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/java.conf``. To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment `` option. Replace ```` with the desired attribute value, for example, ``prod``, as shown in the following example: @@ -209,7 +209,7 @@ Using the installer script, you can install and activate automatic discovery for .. tab:: Installer script - Using the installer script, you can install and activate automatic discovery for Node.js for either all supported Node.js applications on the host via the system-wide method or for only Node.js applications running as ``systemd`` services. + Using the installer script, you can install and activate automatic instrumentation for Node.js for either all supported Node.js applications on the host via the system-wide method or for only Node.js applications running as ``systemd`` services. The installer script installs the Node.js package using the ``npm install`` command. To specify a custom path to ``npm`` for installation, use the ``--npm-path `` option as in the following example: @@ -217,7 +217,7 @@ Using the installer script, you can install and activate automatic discovery for --npm-path /custom/path/to/npm - .. note:: By default, automatic discovery is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic discovery for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. + .. note:: By default, automatic instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. .. tabs:: @@ -234,7 +234,7 @@ Using the installer script, you can install and activate automatic discovery for .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - The system-wide automatic discovery method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``. + The system-wide automatic instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``. You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example: @@ -257,7 +257,7 @@ Using the installer script, you can install and activate automatic discovery for curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --realm -- - The ``systemd`` automatic discovery method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. + The ``systemd`` automatic instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. @@ -296,9 +296,9 @@ Using the installer script, you can install and activate automatic discovery for .. tab:: Installer script - Using the installer script, you can install and activate automatic discovery for .NET for either all supported .NET applications on the host via the system-wide method or for only .NET applications running as ``systemd`` services. + Using the installer script, you can install and activate automatic instrumentation for .NET for either all supported .NET applications on the host via the system-wide method or for only .NET applications running as ``systemd`` services. - .. note:: By default, automatic discovery is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic discovery for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. + .. note:: By default, automatic instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. .. tabs:: @@ -313,7 +313,7 @@ Using the installer script, you can install and activate automatic discovery for .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - The system-wide automatic discovery method automatically adds environment variables to ``/etc/splunk/zeroconfig/dotnet.conf``. + The system-wide automatic instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/dotnet.conf``. To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment `` option. Replace ```` with the desired attribute value, for example, ``prod``, as shown in the following example: @@ -415,7 +415,7 @@ If the service fails to start, check that the ``SPLUNK_REALM`` and ``SPLUNK_ACCE Start your applications ------------------------------------------------ -For automatic discovery to take effect, you must either restart the host or manually start or restart any applications on the host where you installed the package. You must restart the host or applications after installing the automatic discovery package for the first time and whenever you make any changes to the configuration file. +For automatic instrumentation to take effect, you must either restart the host or manually start or restart any applications on the host where you installed the package. You must restart the host or applications after installing the automatic instrumentation package for the first time and whenever you make any changes to the configuration file. After your applications are running, you can verify your data. See :ref:`auto-discovery-view-results-linux`. You can also configure instrumentation settings. See :ref:`auto-discovery-configure-linux`. @@ -433,8 +433,8 @@ To learn more, see the following resources: .. _auto-discovery-upgrade-package: -Update automatic discovery and configuration -============================================ +Update automatic instrumentation +================================================== .. tabs:: @@ -589,7 +589,7 @@ Update automatic discovery and configuration sudo npm install /usr/lib/splunk-instrumentation/splunk-otel-js.tgz - The default automatic discovery configuration expects the Node.js agent to be installed under the ``/usr/lib/splunk-instrumentation/splunk-otel-js`` path. + The default automatic instrumentation configuration expects the Node.js agent to be installed under the ``/usr/lib/splunk-instrumentation/splunk-otel-js`` path. If the Node.js agent is installed under a different path, manually update the path for the ``NODE_OPTIONS`` environment variable in either ``/etc/splunk/zeroconfig/node.conf`` for system-wide services or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` for ``systemd`` services. For example: @@ -683,5 +683,5 @@ To troubleshoot common errors that occur when instrumenting applications, see th View results in Splunk APM ==================================================== -After activating automatic discovery, ensure your data is flowing into Splunk Observability Cloud. See :ref:`verify-apm-data`. +After activating automatic instrumentation, ensure your data is flowing into Splunk Observability Cloud. See :ref:`verify-apm-data`. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst index b6f38743d..0068b2e20 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst @@ -1,13 +1,13 @@ .. _linux-third-party: ********************************************************************************** -Automatic discovery and configuration for third-party applications in Linux +Automatic discovery for third-party services in Linux ********************************************************************************** .. meta:: - :description: Learn how to use automatic discovery and configuration to gather data from third-party applications running in Linux environments. + :description: Learn how to use automatic discovery to gather data from third-party applications running in Linux environments. -You can use automatic discovery and configuration to find third-party applications (such as databases and web servers) running in your Linux environment. Automatic discovery gathers telemetry data from these applications and sends it to Splunk Observability Cloud. +You can use automatic discovery to find third-party applications (such as databases and web servers) running in your Linux environment. Automatic discovery gathers telemetry data from these applications and sends it to Splunk Observability Cloud. .. note:: Update the Collector to version 0.94.0 and higher to activate automatic service discovery. diff --git a/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst b/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst index 2ba2c96b6..3246fbc2b 100644 --- a/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst @@ -1,22 +1,20 @@ .. _windows-backend-auto-discovery: **************************************************************** -Automatic discovery for back-end applications in Windows +Automatic instrumentation for back-end applications in Windows **************************************************************** .. meta:: :description: draft -Automatic discovery can detect the following types of applications in your Windows environment: - -Automatic discovery and configuration for OpenTelemetry .NET activates zero-code instrumentation for .NET applications running on Windows. By default, zero-code instrumentation is only turned on for IIS applications. To activate other application and service types, see :ref:`otel-dotnet-manual-install`. After installing the package, you must start or restart any .NET applications that you want to instrument. +Automatic discovery and instrumentation for OpenTelemetry .NET activates zero-code instrumentation for .NET applications running on Windows. By default, zero-code instrumentation is only turned on for IIS applications. To activate other application and service types, see :ref:`otel-dotnet-manual-install`. After installing the package, you must start or restart any .NET applications that you want to instrument. .. note:: The SignalFx instrumentation for .NET is deprecated and will reach end of support on February 21, 2025. To learn how to migrate from SignalFx .NET to OpenTelemetry .NET, see :ref:`migrate-signalfx-dotnet-to-dotnet-otel`. Get started ================================================== -To get started with automatic discovery for Windows, follow these steps: +To get started with automatic instrumentation for Windows, follow these steps: #. :ref:`windows-install-package` #. :ref:`configure-the-package-dotnet` diff --git a/gdi/opentelemetry/deployments/deployments-ecs-ec2.rst b/gdi/opentelemetry/deployments/deployments-ecs-ec2.rst index 6b6decab7..a2b2ef103 100644 --- a/gdi/opentelemetry/deployments/deployments-ecs-ec2.rst +++ b/gdi/opentelemetry/deployments/deployments-ecs-ec2.rst @@ -7,13 +7,7 @@ Deploy the Collector with Amazon ECS EC2 .. meta:: :description: Deploy the Splunk Observability Cloud OpenTelemetry Collector as a Sidecar in an Amazon ECS EC2 cluster. -Use the guided setup to deploy the Collector as a Sidecar in an Amazon ECS EC2 cluster. The guided setup provides a JSON task definition for the Collector. - -Choose one of the following Collector configuration options: - -- **Default:** The file /etc/otel/collector/ecs_ec2_config.yaml in the Collector image is used for the Collector configuration. -- **File:** Specify the file to use for the Collector configuration. See :ref:`ecs-ec2-custom-config`. -- **AWS Parameter Store:** Specify the AWS Parameter Store key or ARN to use for the Collector configuration. See :ref:`ecs-ec2-custom-config`. +Use the guided setup to deploy the Collector as a sidecar in an Amazon ECS EC2 cluster. To access the guided setup for AWS integration, perform the following steps: @@ -21,18 +15,20 @@ To access the guided setup for AWS integration, perform the following steps: #. On the navigation menu, select :guilabel:`Data Management`. #. Go to the :guilabel:`Available integrations` tab, or select :guilabel:`Add Integration` in the :guilabel:`Deployed integrations` tab. #. Select the tile for :guilabel:`Amazon ECS EC2`. -#. Follow the steps provided in the guided setup. +#. Follow the steps provided in the guided setup, which provides a JSON task definition for the Collector. -Getting started -================================= +Choose one of the following Collector configuration options: -The following sections describe how to create a task definition and launch the Collector. A task definition is required to run Docker containers in Amazon ECS. After creating the task definition, you need to launch the Collector. +- **Default:** The file /etc/otel/collector/ecs_ec2_config.yaml in the Collector image is used for the Collector configuration. +- **File:** Specify the file to use for the Collector configuration. See :ref:`ecs-ec2-custom-config`. +- **AWS Parameter Store:** Specify the AWS Parameter Store key or ARN to use for the Collector configuration. See :ref:`ecs-ec2-aws-store`. -Add the Collector as a Sidecar ---------------------------------- -.. note:: To use this option you need to be familiar with Amazon ECS EC2 launch type. See :new-page:`Getting started with the classic console using Amazon EC2 ` for further reading. +Add the Collector as a sidecar +================================================================== -Open the ECS task definition to which the Collector Sidecar is going to be added: +.. note:: To use this option you need to be familiar with Amazon ECS EC2 launch. See :new-page:`Getting started with the classic console using Amazon EC2 ` for further reading. + +Open the ECS task definition in which you'll add the Collector sidecar: 1. Locate the task definition for the Collector from the :new-page:`repository `. 2. Merge the definitions of the Collector with the existing ECS task definition. @@ -50,8 +46,8 @@ Notes: .. _ecs-ec2-custom-config: -Use a custom configuration -============================== +Deploy the Collector using a custom configuration +============================================================ To use a custom configuration file, replace the value of the ``SPLUNK_CONFIG`` environment variable with the file path of the custom configuration file in the Collector task definition. @@ -59,19 +55,56 @@ Alternatively, you can specify the custom configuration YAML directly using the .. _ecs-observer-config: -Configure ``ecs_observer`` --------------------------------- +Configure the Amazon Elastic Container Service Observer extension +======================================================================= + +Use the Amazon Elastic Container Service Observer (``ecs_observer``) extension in your custom configuration to discover metric targets in running tasks, filtered by service names, task definitions, and container labels. + +Prerequisites +---------------------------------------------------------------- + +The following applies: -Use extension Amazon Elastic Container Service Observer (``ecs_observer``) in your custom configuration to discover metrics targets in running tasks, filtered by service names, task definitions, and container labels. ``ecs_observer`` is currently limited to Prometheus targets and requires the read-only permissions below. The Collector should be configured to run as an ECS Daemon. You can add the permissions to the task role by adding them to a customer-managed policy that is attached to the task role. +* The Collector must run as an ECS daemon. See :ref:`ecs-observer-launch`. +* The ECS Observer is currently limited to Prometheus targets. +* The ECS Observer requires the read-only permissions below. Add them to the customer-managed policy that is attached to the task role. .. code-block:: yaml - ecs:List* - ecs:Describe* + ecs:List* + ecs:Describe* -The following custom configuration examples show the ``ecs_observer`` configured to find Prometheus targets in the ``lorem-ipsum-cluster`` cluster and ``us-west-2`` region, where the task ARN pattern is ``^arn:aws:ecs:us-west-2:906383545488:task-definition/lorem-ipsum-task:[0-9]+$``. +.. _ecs-observer-launch: + +Launch the Collector as a daemon from the ECS console +---------------------------------------------------------------- + +To launch the Collector from the Amazon ECS console: -The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` receiver is configured to read targets from the results file. The values for ``access_token`` and ``realm`` are read from the ``SPLUNK_ACCESS_TOKEN`` and ``SPLUNK_REALM`` environment variables , which must be specified in your container definition. +1. Go to your cluster in the console and select :guilabel:`Services`. + +2. Select :guilabel:`Create` and define the following options: + + * Launch Type: EC2 + + * Task Definition (Family): splunk-otel-collector + + * Task Definition (Revision): 1 (or whatever the latest is in your case) + + * Service Name: splunk-otel-collector + + * Service type: DAEMON + +3. Leave everything else as default and proceed to :guilabel:`Next step` until you're required to create the service. + +4. Select :guilabel:`Create Service` to deploy the Collector onto each node in the ECS cluster. You should see infrastructure and docker metrics flowing soon. + +Configuration example +---------------------------------------------------------------- + +The following example configures the ``ecs_observer`` to find Prometheus targets in the ``lorem-ipsum-cluster`` cluster and ``us-west-2`` region, where the task ARN pattern is ``^arn:aws:ecs:us-west-2:906383545488:task-definition/lorem-ipsum-task:[0-9]+$``. The results are written to ``/etc/ecs_sd_targets.yaml``. + +The ``prometheus`` receiver is configured to read targets from the results file. The values for ``access_token`` and ``realm`` are read from the ``SPLUNK_ACCESS_TOKEN`` and ``SPLUNK_REALM`` environment variables, which you must specify in your container definition. .. code-block:: yaml @@ -111,42 +144,26 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece processors: [batch, resourcedetection] exporters: [signalfx] -.. _aws-parameter-store: +.. _ecs-ec2-aws-store: -Launch the Collector as a Daemon --------------------------------------------- +Deploy the Collector using the AWS Parameter Store +========================================================================================= -To launch the Collector from the Amazon ECS console: - -#. Go to your cluster in the console. -#. Select :guilabel:`Services`. -#. Select :guilabel:`Create`. -#. Select the following options: - #. Launch Type: EC2 - #. Task Definition (Family): splunk-otel-collector - #. Task Definition (Revision): 1 (or whatever the latest is in your case) - #. Service Name: splunk-otel-collector - #. Service type: DAEMON - #. Leave everything else at default. -#. Select :guilabel:`Next step`. -#. Leave everything on this next page at their defaults and select :guilabel:`Next step`. -#. Leave everything on this next page at their defaults and select :guilabel:`Next step`. -#. Select :guilabel:`Create Service` to deploy the Collector onto each node in the ECS cluster. You should see infrastructure and docker metrics flowing soon. +To use the AWS Parameter Store, specify the config YAML directly in the ``SPLUNK_CONFIG_YAML`` environment variable instead of using ``SPLUNK_CONFIG``. -Use the AWS Parameter Store ----------------------------- +.. note:: To have read access to the Parameter Store add the policy ``AmazonSSMReadOnlyAccess`` to the task role. See :new-page:`Systems manager parameter store ` for more information. -Use the ``SPLUNK_CONFIG_YAML`` environment variable to specify the configuration YAML directly. Use ``SPLUNK_CONFIG_YAML`` in place of ``SPLUNK_CONFIG``. +Follow these steps: -For example, first, store the custom configuration for the :ref:`ecs-observer-config` in a parameter called ``splunk-otel-collector-config`` in the AWS Systems Manager Parameter Store.Next, assign the parameter to ``SPLUNK_CONFIG_YAML`` using the ``valueFrom`` option, as shown in the following example: +#. Store the custom configuration for the :ref:`ecs-observer-config` in the parameter ``splunk-otel-collector-config`` in the AWS Systems Manager Parameter Store. +#. Next, assign the ``splunk-otel-collector-config`` parameter to ``SPLUNK_CONFIG_YAML`` using the ``valueFrom`` option, as shown in the following example: .. code-block:: none - { - "name": "lorem-ipsum-cluster", - "valueFrom": "^arn:aws:ecs:us-west-2:906383545488:task-definition/lorem-ipsum-task:[0-9]+$"" - } + { + "name": "lorem-ipsum-cluster", + "valueFrom": "^arn:aws:ecs:us-west-2:906383545488:task-definition/lorem-ipsum-task:[0-9]+$"" + } + +.. caution:: The AWS Parameter Store limits the size of the config file to 4096 bytes. -.. note:: - - You should add policy ``AmazonSSMReadOnlyAccess`` to the task role for the task to have read access to the Parameter Store. See :new-page:`Systems manager parameter store ` for more information. diff --git a/gdi/opentelemetry/discovery-mode.rst b/gdi/opentelemetry/discovery-mode.rst index 0efa57810..711c271a5 100644 --- a/gdi/opentelemetry/discovery-mode.rst +++ b/gdi/opentelemetry/discovery-mode.rst @@ -1,11 +1,11 @@ .. _discovery_mode: *************************************************************************** -Discover telemetry sources automatically +Automatic discovery of apps and services *************************************************************************** .. meta:: - :description: Use automatic discovery and configuration with the Splunk Distribution of OpenTelemetry Collector to collect metrics and traces automatically and easily get started with Splunk Application Performance Monitoring and Splunk Infrastructure Monitoring. + :description: Use automatic discovery and zero-code instrumentation with the Splunk Distribution of the OpenTelemetry Collector to collect metrics and traces automatically and send them to Splunk Observability Cloud. .. toctree:: :hidden: @@ -14,11 +14,9 @@ Discover telemetry sources automatically Linux Windows -Use automatic discovery and configuration (formerly Zero Configuration Automatic Instrumentation) with the Splunk Distribution of OpenTelemetry Collector to collect metrics and traces automatically. +.. include:: /_includes/gdi/auto-discovery-intro.rst -Automatic discovery and configuration helps you quickly get started with Splunk Application Performance Monitoring (APM) and Splunk Infrastructure Monitoring. - -The following diagram shows the process of using automatic discovery and configuration to find data sources: +The following diagram shows how automatic discovery finds data sources: .. mermaid:: @@ -29,60 +27,17 @@ The following diagram shows the process of using automatic discovery and configu X["Connect to your \n cloud environment"] - Y["Deploy the Splunk Distribution \n of OpenTelemetry Collector \n in your environment"] + Y["Deploy the Splunk Distribution \n of the OpenTelemetry Collector \n in your environment"] Z["Run your application"] X --> Y --> Z -Automatic discovery and configuration can detect several types of data sources on the host or Kubernetes cluster, such as language runtimes, databases, and web servers. - -Using this capability, you can automatically instrument your back-end applications such as Java or .NET without any additional installation or configuration steps. With automatic discovery, you can quickly get started with Splunk APM. - -For third-party applications such as databases and web servers, the Collector generates configuration you can modify and adopt, or incorporate into your existing configuration automatically by default. - -The main advantage of using automatic discovery is that you don't need to manually instrument applications or manually configure the Splunk Distribution of OpenTelemetry Collector. - -.. raw:: html - -

Supported language runtimes

- -The following table shows the platforms that support each language runtime: - -.. list-table:: - :header-rows: 1 - :width: 100% - :widths: 25 25 25 25 - - * - Application language - - Supported for Linux - - Supported for Windows - - Supported for Kubernetes - * - Java - - Yes. See :ref:`linux-backend-auto-discovery` - - No - - Yes. See :ref:`k8s-backend-auto-discovery` - * - .NET - - Yes. See :ref:`linux-backend-auto-discovery` - - Yes. See :ref:`windows-backend-auto-discovery` - - Yes. See :ref:`k8s-backend-auto-discovery` - * - Node.js - - Yes. See :ref:`linux-backend-auto-discovery` - - No - - Yes. See :ref:`k8s-backend-auto-discovery` - .. raw:: html -

Supported host services and applications

- -Automatic discovery for third-party applications is supported for Linux and Kubernetes. +

Supported host services and applications for automatic discovery

-To get started with automatic discovery for third-party applications, see the instructions corresponding to your environment: - -* Linux: :ref:`linux-third-party` -* Kubernetes: :ref:`k8s-third-party` - -Automatic discovery supports the following host services and applications: +Automatic discovery of third-party applications is supported in Linux and Kubernetes environments for the following services: .. list-table:: :width: 100% @@ -122,3 +77,35 @@ Automatic discovery supports the following host services and applications: * - Microsoft SQL Server - Microsoft SQL Server receiver. See :ref:`mssql-server-receiver` +Read more: + +* Linux: :ref:`linux-third-party` +* Kubernetes: :ref:`k8s-third-party` + +.. raw:: html + +

Supported language runtimes for zero-code instrumentation

+ +Zero-code instrumentation via the Collector's automatic discovery is available for the following languages: + +.. list-table:: + :header-rows: 1 + :width: 100% + :widths: 25 25 25 25 + + * - Application language + - Supported for Linux + - Supported for Windows + - Supported for Kubernetes + * - Java + - Yes. See :ref:`linux-backend-auto-discovery` + - No + - Yes. See :ref:`k8s-backend-auto-discovery` + * - .NET + - Yes. See :ref:`linux-backend-auto-discovery` + - Yes. See :ref:`windows-backend-auto-discovery` + - Yes. See :ref:`k8s-backend-auto-discovery` + * - Node.js + - Yes. See :ref:`linux-backend-auto-discovery` + - No + - Yes. See :ref:`k8s-backend-auto-discovery` \ No newline at end of file diff --git a/gdi/opentelemetry/opentelemetry.rst b/gdi/opentelemetry/opentelemetry.rst index be5648819..501d90500 100644 --- a/gdi/opentelemetry/opentelemetry.rst +++ b/gdi/opentelemetry/opentelemetry.rst @@ -19,7 +19,7 @@ Get started with the Splunk Distribution of the OpenTelemetry Collector Collector for Windows Splunk Add-On for OpenTelemetry Collector Other deployment tools: ECS EC2, Fargate, Nomad, PCF - Automatic discovery and configuration + Automatic discovery of apps and services Use the Universal Forwarder Monitor the Collector with built-in dashboards Troubleshooting @@ -272,7 +272,7 @@ The Collector also offers a :ref:`zPages extension `, which pr 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. Automatic discovery allows the Collector to automatically grab traces from your application, and add metrics for certain types of calls. See :ref:`discovery_mode`. +* Learn about automatic discovery and zero-code instrumentation (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 see also: