From 0e3a4fda52839a482faec0af9019b42583c901cf Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Thu, 14 Dec 2023 15:02:53 -0600 Subject: [PATCH 01/18] chef install deets --- .../auto-instrumentation-java-linux.rst | 2 +- .../auto-instrumentation-nodejs-linux.rst | 79 +++++++++++-------- .../deployments/deployments-chef.rst | 63 ++++++++++++++- 3 files changed, 107 insertions(+), 37 deletions(-) diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst index 9f38b8567..e85a7e3dc 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst @@ -70,7 +70,7 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin Next, ensure the service is running and restart your application. See :ref:`verify-install` and :ref:`start-restart-java-apps`. - .. tab:: ``systemd`` + .. tab:: systemd Run the installer script with the ``--with-systemd-instrumentation`` option, as shown in the following example. Replace ```` and ```` with your Splunk Observability Cloud realm and token, respectively. diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst index 7cee0834e..7b13f7660 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst @@ -45,59 +45,70 @@ The installer script installs the Node.js package using the ``npm install`` comm .. note:: By default, auto instrumentation is activated for both Java and Node.js when using the installer script. To deactivate auto instrumentation for Java, add the ``--without-instrumentation-sdk java`` or ``--with-instrumentation-sdk node`` option in the installer script command. -.. tabs:: +.. tabs:: - .. tab:: System-wide + .. tab:: Installation script - To install the package, run the Collector installer script with the ``--with-instrumentation`` option. The installer script will install the Collector and the Node.js agent from the Splunk Distribution of OpenTelemetry JS. The Node.js agent automatically loads when a Node.js application starts on the local machine. + Using the installer script, you can install the auto instrumentation package for Node.js and activate auto 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. - Run the installer script with the ``--with-instrumentation`` option, as shown in the following example. Replace ```` and ```` with your Splunk Observability Cloud realm and token, respectively. + .. tabs:: - .. code-block:: bash + .. tab:: System-wide - curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ - sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm -- + To install the package, run the Collector installer script with the ``--with-instrumentation`` option. The installer script will install the Collector and the Node.js agent from the Splunk Distribution of OpenTelemetry JS. The Node.js agent automatically loads when a Node.js application starts on the local machine. - .. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. + Run the installer script with the ``--with-instrumentation`` option, as shown in the following example. Replace ```` and ```` with your Splunk Observability Cloud realm and token, respectively. - The system-wide auto instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``. + .. code-block:: bash - You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example: + curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ + sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm -- - .. code-block:: bash - :emphasize-lines: 4 + .. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ - sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --deployment-environment prod \ - --realm -- \ - --enable-profiler --enable-profiler-memory --enable-metrics + The system-wide auto instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``. - Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`. + You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example: - .. tab:: ``systemd`` + .. code-block:: bash + :emphasize-lines: 4 - Run the installer script with the ``--with-systemd-instrumentation`` option, as shown in the following example. Replace ```` and ```` with your Splunk Observability Cloud realm and token, respectively. - - .. code-block:: bash + curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ + sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --deployment-environment prod \ + --realm -- \ + --enable-profiler --enable-profiler-memory --enable-metrics - 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`` auto instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. + Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`. - .. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. + .. tab:: systemd - You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example: + Run the installer script with the ``--with-systemd-instrumentation`` option, as shown in the following example. Replace ```` and ```` with your Splunk Observability Cloud realm and token, respectively. + + .. code-block:: bash - .. code-block:: bash - :emphasize-lines: 4 + 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`` auto instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. - 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 --deployment-environment prod \ - --realm -- \ - --enable-profiler --enable-profiler-memory --enable-metrics + .. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`. + You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example: + + .. code-block:: bash + :emphasize-lines: 4 + + 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 --deployment-environment prod \ + --realm -- \ + --enable-profiler --enable-profiler-memory --enable-metrics + + .. tab:: Chef + + See :ref:`chef-zero-config-nodejs`. + + + Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`. .. _verify-js-agent-install: diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 5fa6c44d7..47849a8d7 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -155,7 +155,7 @@ The following table shows the variables that can be configured for this Chef coo - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. The specified path is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar`` * - ``auto_instrumentation_resource_attributes`` - - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prod``. The specified resource attributes are added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``''`` * - ``auto_instrumentation_service_name`` - Explicitly sets the service name for the instrumented Java application, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the Java executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. @@ -167,7 +167,7 @@ The following table shows the variables that can be configured for this Chef coo - Prevents the preloader from sending the ``splunk.linux-autoinstr.executions`` metric to the Collector. - ``false`` * - ``auto_instrumentation_enable_profiler`` - - Activates or deactibvates AlwaysOn CPU Profiling. + - Activates or deactivates AlwaysOn CPU Profiling. - ``false`` * - ``auto_instrumentation_enable_profiler_memory`` - Activates or deactivates AlwaysOn Memory Profiling. @@ -176,6 +176,65 @@ The following table shows the variables that can be configured for this Chef coo - Activates or deactivates JVM metrics. - ``false`` +.. _chef-zero-config-nodejs: + +Configure auto instrumentation for Node.js (Linux only) +------------------------------------------------------------- + +You can automatically instrument your Node.js applications along with the Collector installation. Auto instrumentation removes the need to install and configure the Node.js agent separately. See :ref:`auto-instrumentation-nodejs` for more information. + +The following table shows the variables that can be configured with this Chef cookbook: + +.. list-table:: + :widths: 20 30 50 + :header-rows: 1 + + * - Name + - Description + - Default value + * - ``with_auto_instrumentation`` + - Whether to install or manage :ref:`auto-instrumentation-nodejs`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - ``false`` + * - ``auto_instrumentation_version`` + - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.87.0``. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - ``latest`` + * - ``auto_instrumentation_systemd`` + - Whether to install the package using the ``--with-systemd-instrumentation`` instrumentation option. If set to ``true``, the auto instrumentation automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. + - ``false`` + * - ``auto_instrumentation_ld_so_preload`` + - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - ``''`` + * - ``auto_instrumentation_resource_attributes`` + - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - ``''`` + * - ``auto_instrumentation_service_name`` + - Explicitly sets the service name for the instrumented Node.js application, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the Node.js executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - ``''`` + * - ``auto_instrumentation_generate_service_name`` + - Set to ``false`` to prevent the preloader from setting the ``OTEL_SERVICE_NAME`` environment variable. + - ``true`` + * - ``auto_instrumentation_disable_telemetry`` + - Prevents the preloader from sending the ``splunk.linux-autoinstr.executions`` metric to the Collector. + - ``false`` + * - ``auto_instrumentation_enable_profiler`` + - Activates or deactivates AlwaysOn CPU Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. + - ``false`` + * - ``auto_instrumentation_enable_profiler_memory`` + - Activates or deactivates AlwaysOn Memory Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. + - ``false`` + * - ``auto_instrumentation_enable_metrics`` + - Activates or deactivates runtime and custom metrics collection. To learn more, see :ref:`nodejs-otel-metrics`. + - ``false`` + * - ``auto_instrumentation_otlp_endpoint`` + - The Collector endpoint that receives metrics and traces from auto instrumentation. + - ``http://127.0.0.1:4317`` + * - ``with_auto_instrumentation_sdks`` + - The auto instrumentation language SDKs to include. + - ``%w(java nodejs)`` + * - ``auto_instrumentation_npm_path`` + - The installation path for the auto instrumentation Node.js package. + - ``npm`` + Attributes for Windows =========================== For Windows, the cookbook accepts the attributes described in the following table: From bada88b478f69d53263c56113899a20cd08f4199 Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Thu, 14 Dec 2023 15:06:18 -0600 Subject: [PATCH 02/18] format fix --- .../auto-instrumentation-nodejs-linux.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst index 7b13f7660..82fe62952 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst @@ -102,13 +102,15 @@ The installer script installs the Node.js package using the ``npm install`` comm sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --deployment-environment prod \ --realm -- \ --enable-profiler --enable-profiler-memory --enable-metrics + + Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`. + .. tab:: Chef See :ref:`chef-zero-config-nodejs`. - Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`. .. _verify-js-agent-install: From 6a9c6d8ccf388e3b0bb91ad598d568464f6176e6 Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Thu, 14 Dec 2023 15:06:47 -0600 Subject: [PATCH 03/18] another fix --- .../auto-instrumentation/auto-instrumentation-nodejs-linux.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst index 82fe62952..f566aecc2 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst @@ -47,7 +47,7 @@ The installer script installs the Node.js package using the ``npm install`` comm .. tabs:: - .. tab:: Installation script + .. tab:: Installer script Using the installer script, you can install the auto instrumentation package for Node.js and activate auto 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. From bcb4d07ef76ce11634fa78d50f61312dfda3091c Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Fri, 15 Dec 2023 13:14:34 -0600 Subject: [PATCH 04/18] windows changes --- .../auto-instrumentation-java-linux.rst | 2 +- .../auto-instrumentation-nodejs-linux.rst | 2 +- .../auto-instrumentation-nodejs.rst | 3 +- .../deployments/deployments-chef.rst | 220 +++++------------- 4 files changed, 65 insertions(+), 162 deletions(-) diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst index e85a7e3dc..6341ed56c 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-linux.rst @@ -146,7 +146,7 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin .. tab:: Chef - See :ref:`chef-zero-config-java`. + See :ref:`chef-zero-config`. .. tab:: Puppet diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst index f566aecc2..9be96e6f9 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst @@ -108,7 +108,7 @@ The installer script installs the Node.js package using the ``npm install`` comm .. tab:: Chef - See :ref:`chef-zero-config-nodejs`. + See :ref:`chef-zero-config`. diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs.rst index 4e8a6e088..dbc85ecc3 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs.rst @@ -12,8 +12,9 @@ Splunk OpenTelemetry Zero Config Auto Instrumentation for Node.js .. toctree:: :hidden: - Kubernetes Linux + Kubernetes + Splunk OpenTelemetry (OTel) Zero Configuration Auto Instrumentation for Node.js automatically instruments supported Node.js libraries in running applications to capture distributed traces. The Splunk OpenTelemetry Collector receives the distributed traces and forwards them to Splunk Application Performance Monitoring (APM) in Splunk Observability Cloud. diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 47849a8d7..58b10bc51 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -126,201 +126,103 @@ For Linux, the cookbook accepts the attributes described in the following table: - Destination path to the Fluentd configuration file on the node. Only applicable if ``$with_fluentd`` is set to ``true``. - ``/etc/otel/collector/fluentd/fluent.conf`` -.. _chef-zero-config-java: +.. _chef-zero-config: -Configure auto instrumentation for Java (Linux only) -------------------------------------------------------------- +Configure auto instrumentation for Java and Node.js (Linux only) +------------------------------------------------------------------ -You can automatically instrument your Java applications along with the Collector installation. Auto instrumentation removes the need to install and configure the Java agent separately. See :ref:`configure-auto-instrumentation` for more information. +You can automatically instrument your Java and Node.js applications along with the Collector installation. Auto instrumentation removes the need to install and configure OpenTelemetry agents separately. See :ref:`zero-config` for more information. -The following table shows the variables that can be configured for this Chef cookbook: +The following table shows the variables that can be configured with this Chef cookbook: .. list-table:: - :widths: 20 30 50 + :widths: 20 50 30 :header-rows: 1 * - Name - Description - Default value * - ``with_auto_instrumentation`` - - Whether to install or manage :ref:`auto-instrumentation-java`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Whether to install or manage :ref:`auto-instrumentation-nodejs`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``false`` * - ``auto_instrumentation_version`` - - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48.0``. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48`` for Java and ``0.87.0`` for Node.js. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``latest`` + * - ``auto_instrumentation_systemd`` + - Whether to activate and configure the auto instrumentation for ``systemd`` services only. If set to ``true``, the auto instrumentation automatically environment variables are added to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. + - ``false`` * - ``auto_instrumentation_ld_so_preload`` - - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for system-wide auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``''`` - * - ``auto_instrumentation_java_agent_path`` - - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. The specified path is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar`` * - ``auto_instrumentation_resource_attributes`` - - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/etc/splunk/zeroconfig/node.conf`` configuration file on the node, or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` if using the ``systemd`` installation method. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``''`` * - ``auto_instrumentation_service_name`` - - Explicitly sets the service name for the instrumented Java application, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the Java executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Explicitly sets the service name for all instrumented applications on the node, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the application executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``''`` - * - ``auto_instrumentation_generate_service_name`` - - Set to ``false`` to prevent the preloader from setting the ``OTEL_SERVICE_NAME`` environment variable. - - ``true`` - * - ``auto_instrumentation_disable_telemetry`` - - Prevents the preloader from sending the ``splunk.linux-autoinstr.executions`` metric to the Collector. - - ``false`` * - ``auto_instrumentation_enable_profiler`` - - Activates or deactivates AlwaysOn CPU Profiling. + - Activates or deactivates AlwaysOn CPU Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. - ``false`` * - ``auto_instrumentation_enable_profiler_memory`` - - Activates or deactivates AlwaysOn Memory Profiling. + - Activates or deactivates AlwaysOn Memory Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. - ``false`` * - ``auto_instrumentation_enable_metrics`` - - Activates or deactivates JVM metrics. + - Activates or deactivates exporting instrumentation metrics. - ``false`` + * - ``auto_instrumentation_otlp_endpoint`` + - Sets the OTLP gRPC endpoint that receives traces. Only applicable for OpenTelemetry Collector versions ``0.87`` and higher. + - ``http://127.0.0.1:4317`` + * - ``with_auto_instrumentation_sdks`` + - The auto instrumentation language SDKs to include. + - ``%w(java nodejs)`` + * - ``auto_instrumentation_java_agent_path`` + - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. The specified path is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar`` + * - ``auto_instrumentation_npm_path`` + - The installation path for the ``npm`` command. + - ``npm`` -.. _chef-zero-config-nodejs: - -Configure auto instrumentation for Node.js (Linux only) -------------------------------------------------------------- - -You can automatically instrument your Node.js applications along with the Collector installation. Auto instrumentation removes the need to install and configure the Node.js agent separately. See :ref:`auto-instrumentation-nodejs` for more information. +Configure auto instrumentation for SignalFx .NET (Windows only) +================================================================= -The following table shows the variables that can be configured with this Chef cookbook: +You can automatically instrument your .NET applications along with the Collector installation. Auto instrumentation removes the need to install and configure the SignalFx .NET agent separately. See :ref:`zero-config` for more information. -.. list-table:: - :widths: 20 30 50 - :header-rows: 1 - - * - Name - - Description - - Default value - * - ``with_auto_instrumentation`` - - Whether to install or manage :ref:`auto-instrumentation-nodejs`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``false`` - * - ``auto_instrumentation_version`` - - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.87.0``. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``latest`` - * - ``auto_instrumentation_systemd`` - - Whether to install the package using the ``--with-systemd-instrumentation`` instrumentation option. If set to ``true``, the auto instrumentation automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. - - ``false`` - * - ``auto_instrumentation_ld_so_preload`` - - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``''`` - * - ``auto_instrumentation_resource_attributes`` - - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``''`` - * - ``auto_instrumentation_service_name`` - - Explicitly sets the service name for the instrumented Node.js application, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the Node.js executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Node.js application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``''`` - * - ``auto_instrumentation_generate_service_name`` - - Set to ``false`` to prevent the preloader from setting the ``OTEL_SERVICE_NAME`` environment variable. - - ``true`` - * - ``auto_instrumentation_disable_telemetry`` - - Prevents the preloader from sending the ``splunk.linux-autoinstr.executions`` metric to the Collector. - - ``false`` - * - ``auto_instrumentation_enable_profiler`` - - Activates or deactivates AlwaysOn CPU Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. - - ``false`` - * - ``auto_instrumentation_enable_profiler_memory`` - - Activates or deactivates AlwaysOn Memory Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. - - ``false`` - * - ``auto_instrumentation_enable_metrics`` - - Activates or deactivates runtime and custom metrics collection. To learn more, see :ref:`nodejs-otel-metrics`. - - ``false`` - * - ``auto_instrumentation_otlp_endpoint`` - - The Collector endpoint that receives metrics and traces from auto instrumentation. - - ``http://127.0.0.1:4317`` - * - ``with_auto_instrumentation_sdks`` - - The auto instrumentation language SDKs to include. - - ``%w(java nodejs)`` - * - ``auto_instrumentation_npm_path`` - - The installation path for the auto instrumentation Node.js package. - - ``npm`` - -Attributes for Windows -=========================== -For Windows, the cookbook accepts the attributes described in the following table: +The cookbook accepts the attributes described in the following table: .. list-table:: - :widths: 25 45 30 + :widths: 20 50 30 :header-rows: 1 * - Name - Description - Default value - * - ``collector_version`` - - Version of the Collector package to install, for example, ``0.25.0``. The version should correspond to :new-page:`Github Releases ` without the preceding ``v``. Note that on Linux, the latest Collector version is installed if this parameter is not specified. - - None - * - ``splunk_access_token`` - - The Splunk access token to authenticate requests. This attribute is required. - - None - * - ``splunk_realm`` - - Which realm to send the data to, for example, ``us0``. The Splunk ingest and API URLs are inferred by this value. The ``SPLUNK_REALM`` environment variable is set with this value for the collector service. This attribute is required. - - None - * - ``splunk_ingest_url`` - - Sets the Splunk ingest URL explicitly instead of the URL inferred by the ``$splunk_realm`` parameter. The ``SPLUNK_INGEST_URL`` environment variable is set with this value for the Collector service. - - ``https://ingest.${splunk_realm}.signalfx.com`` - * - ``splunk_api_url`` - - Sets the Splunk API URL explicitly instead of the URL inferred by the ``$splunk_realm`` parameter. The ``SPLUNK_API_URL`` environment variable is set with this value for the Collector service. - - ``https://api.${splunk_realm}.signalfx.com`` - * - ``splunk_trace_url`` - - Sets the Splunk trace endpoint URL explicitly instead of the URL inferred by the ``$splunk_ingest_url`` parameter. The ``SPLUNK_TRACE_URL`` environment variable is set with this value for the Collector service. - - ``${splunk_ingest_url}/v2/trace`` - * - ``splunk_hec_url`` - - Sets the Splunk HEC endpoint URL explicitly instead of the URL inferred by the ``$splunk_ingest_url`` parameter. The ``SPLUNK_HEC_URL`` environment variable is set with this value for the Collector service. - - ``${splunk_ingest_url}/v1/log`` - * - ``splunk_hec_token`` - - Sets the Splunk HEC authentication token if different than ``$splunk_access_token``. The ``SPLUNK_HEC_TOKEN`` environment variable is set with this value for the Collector service. - - ``$splunk_access_token`` - * - ``splunk_bundle_dir`` - - The path to the Smart Agent bundle directory. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the node. The ``SPLUNK_BUNDLE_DIR`` environment variable is set to this value for the Collector service. - - ``/usr/lib/splunk-otel-collector/agent-bundle`` - * - ``splunk_collectd_dir`` - - The path to the collectd configuration directory for the Smart Agent bundle. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the node. The ``SPLUNK_COLLECTD_DIR`` environment variable is set to this value for the Collector service. - - ``%ProgramFiles%\Splunk\OpenTelemetry Collector\agent-bundle\run\collectd`` - * - ``splunk_memory_total_mib`` - - Total memory in MIB to allocate to the Collector; automatically calculates the ballast size. The ``SPLUNK_MEMORY_TOTAL_MIB`` environment variable is set to this value for the Collector service. - - ``512`` - * - ``splunk_ballast_size_mib`` - - Sets the ballast size for the Collector explicitly instead of the value calculated from the ``$splunk_memory_total_mib`` parameter. This should be set to 1/3 to 1/2 of configured memory. The ``SPLUNK_BALLAST_SIZE_MIB`` environment variable is set to this value for the Collector service. - - ``"`` - * - ``collector_config_source`` - - The source path to the Collector configuration YAML file. This file is copied to the ``$collector_config_dest`` path on the node. See the :new-page:`source attribute ` of the file resource for the supported value types. The default source file is provided by the Collector package. - - ``%ProgramFiles%\Splunk\OpenTelemetry Collector\agent_config.yaml`` - * - ``collector_config_dest`` - - Destination path of the Collector configuration file on the node. The ``SPLUNK_CONFIG`` environment variable is set with this value for the Collector service. - - ``%PROGRAMDATA%\Splunk\OpenTelemetry Collector\agent_config.yaml`` - * - ``node['splunk_otel_collector']['collector_config']`` - - The Collector configuration object. Everything underneath this object gets directly converted to YAML and becomes the Collector configuration file. Using this option preempts ``collector_config_source`` functionality. - - ``{}`` - * - ``service_user`` and ``$service_group`` - - Sets the user or group ownership for the Collector service. The user or group is created if they do not exist. - - ``splunk-otel-collector`` - * - ``package_stage`` - - The Collector package repository stage to use. Can be ``release``, ``beta``, or ``test``. - - ``release`` - * - ``with_fluentd`` - - Whether to install or manage Fluentd and dependencies for log collection. On Linux, the dependencies include ``capng_c`` for activating Linux capabilities, ``fluent-plugin-systemd`` for systemd journal log collection, and the required libraries and development tools. - - ``true`` - * - ``fluentd_version`` - - Version of the td-agent (Fluentd) package to install - - ``4.3.1`` - * - ``fluentd_config_source`` - - Source path to the Fluentd configuration file. This file is copied to the ``$fluentd_config_dest`` path on the node. See the :new-page:`source attribute ` of the file resource for the supported value types. The default source file is provided by the Collector package. Only applicable if ``$with_fluentd`` is set to ``true``. - - ``%SYSTEMDRIVE%\opt\td-agent\etc\td-agent\td-agent.conf`` - * - ``with_auto_instrumentation`` - - Whether to install or manage :ref:`auto-instrumentation-java`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + * - ``with_signalfx_dotnet_instrumentation`` + - Whether to install or manage :ref:`auto-instrumentation-dotnet`. When set to ``true``, the ``signalfx-dotnet-tracing`` MSI package will be downloaded and installed, and the Windows registry will be updated based on other configuration options. - ``false`` - * - ``auto_instrumentation_version`` - - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48.0``. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``latest`` - * - ``auto_instrumentation_ld_so_preload`` - - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``''`` - * - ``auto_instrumentation_java_agent_path`` - - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. The specified path is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - - ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar`` - * - ``auto_instrumentation_resource_attributes`` - - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prod``. The specified resource attributes are added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + * - ``signalfx_dotnet_auto_instrumentation_version`` + - Version of the ``signalfx-dotnet-tracing`` MSI package to download and install. + - ``1.1.0`` + * - ``signalfx_dotnet_auto_instrumentation_msi_url`` + - Specify the URL to download the MSI from a custom host, for example ``https://my.host/signalfx-dotnet-tracing-1.0.0-x64.msi``. If specified, the ``signalfx_dotnet_auto_instrumentation_version`` option is ignored. + - ``https://github.com/signalfx/signalfx-dotnet-tracing/releases/download/v{{ signalfx_dotnet_auto_instrumentation_version }}/signalfx-dotnet-tracing-{{ signalfx_dotnet_auto_instrumentation_version }}-x64.msi`` + * - ``signalfx_dotnet_auto_instrumentation_iisreset`` + - By default, the ``iisreset.exe`` command will be executed after installation/configuration in order for any changes to take effect for IIS applications. Set this option to ``false`` to skip this step if IIS is managed separately or is not applicable. + - ``false`` + * - ``signalfx_dotnet_auto_instrumentation_system_wide`` + - Whether to configure auto instrumentation for all .NET applications on the node. When set to ``true``, all attributes and environment variables are added to the ``HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment`` registry key. + - ``false`` + * - ``signalfx_dotnet_auto_instrumentation_environment`` + - Sets the deployment environment variable that is reported to Splunk APM, for example ``production``. The value is assigned to the ``SIGNALFX_ENV`` environment variable in the Windows registry. - ``''`` - * - ``auto_instrumentation_service_name`` - - Explicitly sets the service name for the instrumented Java application, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the Java executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + * - ``signalfx_dotnet_auto_instrumentation_service_name`` + - Sets the service name for the instrumented application, for example, ``my-service``. The value is assigned to the ``SIGNALFX_SERVICE_NAME`` environment variable in the Windows registry. - ``''`` + * - ``signalfx_dotnet_auto_instrumentation_enable_profiler`` + - Activates or deactivates AlwaysOn Profiling. The value will be assigned to the ``SIGNALFX_PROFILER_ENABLED`` environment variable in the Windows registry. + - ``false`` + * - ``signalfx_dotnet_auto_instrumentation_enable_profiler_memory`` + - Activates or deactivates AlwaysOn Memory Profiling. The value will be assigned to the ``SIGNALFX_PROFILER_MEMORY_ENABLED`` environment variable in the Windows registry. + - ``false`` + * - ``signalfx_dotnet_auto_instrumentation_additional_options`` + - Hash of additional options to be added to the Windows registry in addition to the options above. To learn more, see :ref:`advanced-dotnet-configuration`. + - ``{}`` \ No newline at end of file From 0e8daca57e521971210a258a28b84b882f9d8dde Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Fri, 15 Dec 2023 13:39:57 -0600 Subject: [PATCH 05/18] tabs fix --- .../auto-instrumentation/auto-instrumentation-java-k8s.rst | 2 +- .../auto-instrumentation/auto-instrumentation-nodejs-k8s.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-k8s.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-k8s.rst index f33ca7de6..b9c0fe0a1 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-k8s.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-k8s.rst @@ -70,7 +70,7 @@ The following examples demonstrate how to set the attribute using each method: .. tabs:: - .. tab:: ``values.yaml`` (Environment option) + .. tab:: ``values.yaml`` Set the ``environment`` option in the ``values.yaml`` file. This adds the ``deployment.environment`` attribute to all telemetry data the Collector receives, including data from automatically-instrumented pods. diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-k8s.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-k8s.rst index 5b12469c3..dc6dba41c 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-k8s.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-k8s.rst @@ -75,7 +75,7 @@ The following examples demonstrate how to set the attribute using each method: .. tabs:: - .. tab:: ``values.yaml`` (Environment option) + .. tab:: ``values.yaml`` Set the ``environment`` option in the ``values.yaml`` file. This adds the ``deployment.environment`` attribute to all telemetry data the Collector receives, including data from automatically-instrumented pods. From 0628f337ddec2b1144f69761bf96aa53bd937942 Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:08:01 -0600 Subject: [PATCH 06/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 58b10bc51..79253cb8b 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -170,7 +170,7 @@ The following table shows the variables that can be configured with this Chef co - Activates or deactivates exporting instrumentation metrics. - ``false`` * - ``auto_instrumentation_otlp_endpoint`` - - Sets the OTLP gRPC endpoint that receives traces. Only applicable for OpenTelemetry Collector versions ``0.87`` and higher. + - Sets the OTLP gRPC endpoint that receives traces. Only applicable for OpenTelemetry Collector versions ``0.87.0`` and higher. - ``http://127.0.0.1:4317`` * - ``with_auto_instrumentation_sdks`` - The auto instrumentation language SDKs to include. From d05eeb1fe5039e2993b365e9341a69284c040e87 Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:08:09 -0600 Subject: [PATCH 07/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 79253cb8b..ba9304a6a 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -179,7 +179,7 @@ The following table shows the variables that can be configured with this Chef co - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. The specified path is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar`` * - ``auto_instrumentation_npm_path`` - - The installation path for the ``npm`` command. + - The path to the pre-installed ``npm`` command, e.g. ``/my/custom/path/to/npm``. - ``npm`` Configure auto instrumentation for SignalFx .NET (Windows only) From f0a4ba52b6d6560535d9c586b76506443b8a4bf5 Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:08:24 -0600 Subject: [PATCH 08/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index ba9304a6a..340a385f9 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -158,7 +158,7 @@ The following table shows the variables that can be configured with this Chef co - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/etc/splunk/zeroconfig/node.conf`` configuration file on the node, or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` if using the ``systemd`` installation method. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``''`` * - ``auto_instrumentation_service_name`` - - Explicitly sets the service name for all instrumented applications on the node, for example, ``my.service``. By default, the service name is automatically derived from the arguments of the application executable on the node. However, if this variable is set to a non-empty value, the value overrides the derived service name and is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Explicitly sets the service name for all instrumented applications on the node, for example, ``my.service``. By default, the service name is automatically derived for each instrumented application. However, if this variable is set to a non-empty value, the value overrides the derived service names. - ``''`` * - ``auto_instrumentation_enable_profiler`` - Activates or deactivates AlwaysOn CPU Profiling. To learn more, see :ref:`profiling-configuration-nodejs`. From 0386258c38ce9a6c907da42f111dd2b0c27accb1 Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:08:45 -0600 Subject: [PATCH 09/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 340a385f9..d8e3cb57c 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -143,7 +143,7 @@ The following table shows the variables that can be configured with this Chef co - Description - Default value * - ``with_auto_instrumentation`` - - Whether to install or manage :ref:`auto-instrumentation-nodejs`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Whether to install or manage :ref:`auto-instrumentation-nodejs` and/or :ref:`auto-instrumentation-java`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. - ``false`` * - ``auto_instrumentation_version`` - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48`` for Java and ``0.87.0`` for Node.js. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. From d625e4ca95c40e22326694a03991423af1baf44c Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:08:56 -0600 Subject: [PATCH 10/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index d8e3cb57c..1abe96210 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -131,7 +131,7 @@ For Linux, the cookbook accepts the attributes described in the following table: Configure auto instrumentation for Java and Node.js (Linux only) ------------------------------------------------------------------ -You can automatically instrument your Java and Node.js applications along with the Collector installation. Auto instrumentation removes the need to install and configure OpenTelemetry agents separately. See :ref:`zero-config` for more information. +You can automatically instrument your Java and Node.js applications along with the Collector installation. Auto instrumentation removes the need to install and configure OpenTelemetry agents separately. See :ref:`zero-config` for more information. The applications to be instrumented on the node need to be started or restarted separately after installation or any configuration changes for auto instrumentation to take effect. The following table shows the variables that can be configured with this Chef cookbook: From de5f8a1b95888591f309a633591300ec98eb735f Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:09:12 -0600 Subject: [PATCH 11/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 1abe96210..b19228068 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -146,7 +146,7 @@ The following table shows the variables that can be configured with this Chef co - Whether to install or manage :ref:`auto-instrumentation-nodejs` and/or :ref:`auto-instrumentation-java`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. - ``false`` * - ``auto_instrumentation_version`` - - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48`` for Java and ``0.87.0`` for Node.js. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48`` for Java and ``0.87.0`` for Node.js. - ``latest`` * - ``auto_instrumentation_systemd`` - Whether to activate and configure the auto instrumentation for ``systemd`` services only. If set to ``true``, the auto instrumentation automatically environment variables are added to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. From 96f4653747be20c657d5128ed2137ce61107f07a Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:09:21 -0600 Subject: [PATCH 12/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index b19228068..629f57f59 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -155,7 +155,7 @@ The following table shows the variables that can be configured with this Chef co - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for system-wide auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. - ``''`` * - ``auto_instrumentation_resource_attributes`` - - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd``. The specified resource attributes are added to the ``/etc/splunk/zeroconfig/node.conf`` configuration file on the node, or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` if using the ``systemd`` installation method. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd,my.key=my.value`` (comma-separated string of ``key=value`` pairs). The specified resource attributes are added to the ``/etc/splunk/zeroconfig/node.conf`` configuration file on the node, or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` if using the ``systemd`` installation method. - ``''`` * - ``auto_instrumentation_service_name`` - Explicitly sets the service name for all instrumented applications on the node, for example, ``my.service``. By default, the service name is automatically derived for each instrumented application. However, if this variable is set to a non-empty value, the value overrides the derived service names. From 1860ba58fe21d239372413e622902e8880d2624b Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:09:27 -0600 Subject: [PATCH 13/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 629f57f59..569984c5c 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -176,7 +176,7 @@ The following table shows the variables that can be configured with this Chef co - The auto instrumentation language SDKs to include. - ``%w(java nodejs)`` * - ``auto_instrumentation_java_agent_path`` - - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. The specified path is added to the ``/usr/lib/splunk-instrumentation/instrumentation.conf`` configuration file on the node. The Java application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. - ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar`` * - ``auto_instrumentation_npm_path`` - The path to the pre-installed ``npm`` command, e.g. ``/my/custom/path/to/npm``. From 3c2ba8707963049a42d5da5f205e7249401ffc92 Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:09:34 -0600 Subject: [PATCH 14/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 569984c5c..46f1ec78d 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -173,7 +173,7 @@ The following table shows the variables that can be configured with this Chef co - Sets the OTLP gRPC endpoint that receives traces. Only applicable for OpenTelemetry Collector versions ``0.87.0`` and higher. - ``http://127.0.0.1:4317`` * - ``with_auto_instrumentation_sdks`` - - The auto instrumentation language SDKs to include. + - The auto instrumentation language SDKs to install and activate. - ``%w(java nodejs)`` * - ``auto_instrumentation_java_agent_path`` - Path to the Splunk OpenTelemetry Java agent. The default path is provided by the ``splunk-otel-auto-instrumentation`` package. If the path is changed from the default value, the path should be an existing file on the node. From 8482086d9cfb625d4ee1d21f97fe94e97ea673a6 Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 5 Jan 2024 15:09:40 -0600 Subject: [PATCH 15/18] Update gdi/opentelemetry/deployments/deployments-chef.rst Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --- gdi/opentelemetry/deployments/deployments-chef.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 46f1ec78d..f12c03305 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -152,7 +152,7 @@ The following table shows the variables that can be configured with this Chef co - Whether to activate and configure the auto instrumentation for ``systemd`` services only. If set to ``true``, the auto instrumentation automatically environment variables are added to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. - ``false`` * - ``auto_instrumentation_ld_so_preload`` - - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for system-wide auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. The application on the node needs to be started or restarted separately after installation for auto instrumentation to take effect. + - By default, the ``/etc/ld.so.preload`` file on the node is configured for the ``/usr/lib/splunk-instrumentation/libsplunk.so`` shared object library provided by the ``splunk-otel-auto-instrumentation`` package and is required for system-wide auto instrumentation. Configure this variable to include additional library paths, for example, ``/path/to/my.library.so``. - ``''`` * - ``auto_instrumentation_resource_attributes`` - Configure the OpenTelemetry instrumentation resource attributes, for example, ``deployment.environment=prd,my.key=my.value`` (comma-separated string of ``key=value`` pairs). The specified resource attributes are added to the ``/etc/splunk/zeroconfig/node.conf`` configuration file on the node, or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` if using the ``systemd`` installation method. From 7c1eb87b94f455cb58c60f2364e271ca3f1556c5 Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Fri, 5 Jan 2024 15:13:19 -0600 Subject: [PATCH 16/18] move note --- .../auto-instrumentation-nodejs-linux.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst index 9be96e6f9..6daf401c8 100644 --- a/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst +++ b/gdi/opentelemetry/auto-instrumentation/auto-instrumentation-nodejs-linux.rst @@ -43,14 +43,14 @@ The installer script installs the Node.js package using the ``npm install`` comm --npm-path /custom/path/to/npm -.. note:: By default, auto instrumentation is activated for both Java and Node.js when using the installer script. To deactivate auto instrumentation for Java, add the ``--without-instrumentation-sdk java`` or ``--with-instrumentation-sdk node`` option in the installer script command. - .. tabs:: .. tab:: Installer script Using the installer script, you can install the auto instrumentation package for Node.js and activate auto 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. + .. note:: By default, auto instrumentation is activated for both Java and Node.js when using the installer script. To deactivate auto instrumentation for Java, add the ``--without-instrumentation-sdk java`` or ``--with-instrumentation-sdk node`` option in the installer script command. + .. tabs:: .. tab:: System-wide From 61e8850256d9f06932d491b4da8e664b4306c6b9 Mon Sep 17 00:00:00 2001 From: Max Bechtold Date: Thu, 11 Jan 2024 12:32:26 -0600 Subject: [PATCH 17/18] initial commit --- admin/subscription-usage/parent-child-orgs.rst | 2 +- infrastructure/metrics-pipeline/aggregate-drop-use-case.rst | 2 +- infrastructure/metrics-pipeline/data-dropping-impact.rst | 2 +- infrastructure/metrics-pipeline/metrics-pipeline-intro.rst | 2 +- infrastructure/metrics-pipeline/metrics-pipeline.rst | 2 +- infrastructure/metrics-pipeline/use-metrics-pipeline.rst | 2 +- infrastructure/mpm-arm/aggregate-drop-use-case.rst | 2 +- infrastructure/mpm-arm/data-dropping-impact.rst | 2 +- infrastructure/mpm-arm/delete-metric-ruleset.rst | 2 +- infrastructure/mpm-arm/metrics-pipeline-intro.rst | 2 +- infrastructure/mpm-arm/metrics-pipeline.rst | 2 +- infrastructure/mpm-arm/pipeline-management-use-cases.rst | 2 +- infrastructure/mpm-arm/use-MTS-aggregation-pipeline.rst | 2 +- infrastructure/mpm-arm/use-MTS-data-routing-pipeline.rst | 2 +- infrastructure/mpm-arm/use-metrics-pipeline.rst | 2 +- infrastructure/mpm-arm/view-metrics-usage-list.rst | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/admin/subscription-usage/parent-child-orgs.rst b/admin/subscription-usage/parent-child-orgs.rst index 376a3ef12..c9c4c4f57 100644 --- a/admin/subscription-usage/parent-child-orgs.rst +++ b/admin/subscription-usage/parent-child-orgs.rst @@ -48,6 +48,6 @@ To view the available usage reports: :width: 70% :alt: The usage report shows the parent org data separate from the child org usage data. -For more details about Service Bureau or parent-child orgs, contact your Account team or Splunk Support. +For more details about parent-child orgs, contact your Account team or Splunk Support. .. note:: To see child org metrics, refer to :ref:`Organization metrics in child orgs `. \ No newline at end of file diff --git a/infrastructure/metrics-pipeline/aggregate-drop-use-case.rst b/infrastructure/metrics-pipeline/aggregate-drop-use-case.rst index 203b58c63..9963e6c6f 100644 --- a/infrastructure/metrics-pipeline/aggregate-drop-use-case.rst +++ b/infrastructure/metrics-pipeline/aggregate-drop-use-case.rst @@ -10,7 +10,7 @@ Scenario: Combine aggregation and dropping rules to control your metric cardinal |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/metrics-pipeline/data-dropping-impact.rst b/infrastructure/metrics-pipeline/data-dropping-impact.rst index 4eba66a72..ee952038b 100644 --- a/infrastructure/metrics-pipeline/data-dropping-impact.rst +++ b/infrastructure/metrics-pipeline/data-dropping-impact.rst @@ -11,7 +11,7 @@ Impact and benefits of dropping data |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/metrics-pipeline/metrics-pipeline-intro.rst b/infrastructure/metrics-pipeline/metrics-pipeline-intro.rst index 656836899..4bb5a1936 100644 --- a/infrastructure/metrics-pipeline/metrics-pipeline-intro.rst +++ b/infrastructure/metrics-pipeline/metrics-pipeline-intro.rst @@ -10,7 +10,7 @@ Introduction to metrics pipeline management |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/metrics-pipeline/metrics-pipeline.rst b/infrastructure/metrics-pipeline/metrics-pipeline.rst index a0d19c721..120972579 100644 --- a/infrastructure/metrics-pipeline/metrics-pipeline.rst +++ b/infrastructure/metrics-pipeline/metrics-pipeline.rst @@ -10,7 +10,7 @@ Metrics pipeline management in Splunk Infrastructure Monitoring |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/metrics-pipeline/use-metrics-pipeline.rst b/infrastructure/metrics-pipeline/use-metrics-pipeline.rst index f5e5e1168..17b8697c2 100644 --- a/infrastructure/metrics-pipeline/use-metrics-pipeline.rst +++ b/infrastructure/metrics-pipeline/use-metrics-pipeline.rst @@ -10,7 +10,7 @@ Control your metric ingestion volume with rules |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/aggregate-drop-use-case.rst b/infrastructure/mpm-arm/aggregate-drop-use-case.rst index ad0474ed4..e4c161f73 100644 --- a/infrastructure/mpm-arm/aggregate-drop-use-case.rst +++ b/infrastructure/mpm-arm/aggregate-drop-use-case.rst @@ -13,7 +13,7 @@ Scenario: Combine aggregation and dropping rules to control your metric cardinal |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/data-dropping-impact.rst b/infrastructure/mpm-arm/data-dropping-impact.rst index 4e9c8a713..58334f9e9 100644 --- a/infrastructure/mpm-arm/data-dropping-impact.rst +++ b/infrastructure/mpm-arm/data-dropping-impact.rst @@ -14,7 +14,7 @@ Impact and benefits of dropping data |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/delete-metric-ruleset.rst b/infrastructure/mpm-arm/delete-metric-ruleset.rst index 60a0ce3ce..2b2facec2 100644 --- a/infrastructure/mpm-arm/delete-metric-ruleset.rst +++ b/infrastructure/mpm-arm/delete-metric-ruleset.rst @@ -13,7 +13,7 @@ Delete a metrics ruleset |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/metrics-pipeline-intro.rst b/infrastructure/mpm-arm/metrics-pipeline-intro.rst index 123b4614a..eb01a34f6 100644 --- a/infrastructure/mpm-arm/metrics-pipeline-intro.rst +++ b/infrastructure/mpm-arm/metrics-pipeline-intro.rst @@ -14,7 +14,7 @@ Optimizing metrics data |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/metrics-pipeline.rst b/infrastructure/mpm-arm/metrics-pipeline.rst index 7b632b23a..8b2d1adcc 100644 --- a/infrastructure/mpm-arm/metrics-pipeline.rst +++ b/infrastructure/mpm-arm/metrics-pipeline.rst @@ -13,7 +13,7 @@ Metrics pipeline management in Splunk Infrastructure Monitoring |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/pipeline-management-use-cases.rst b/infrastructure/mpm-arm/pipeline-management-use-cases.rst index 1a3714183..f15dc6744 100644 --- a/infrastructure/mpm-arm/pipeline-management-use-cases.rst +++ b/infrastructure/mpm-arm/pipeline-management-use-cases.rst @@ -13,7 +13,7 @@ Use case: Improve storage use and monitoring performance using data routing and |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/use-MTS-aggregation-pipeline.rst b/infrastructure/mpm-arm/use-MTS-aggregation-pipeline.rst index 97af28170..0a08f45bb 100644 --- a/infrastructure/mpm-arm/use-MTS-aggregation-pipeline.rst +++ b/infrastructure/mpm-arm/use-MTS-aggregation-pipeline.rst @@ -13,7 +13,7 @@ Control your data ingestion volume with aggregation rules |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/use-MTS-data-routing-pipeline.rst b/infrastructure/mpm-arm/use-MTS-data-routing-pipeline.rst index a864412fa..f5008ce33 100644 --- a/infrastructure/mpm-arm/use-MTS-data-routing-pipeline.rst +++ b/infrastructure/mpm-arm/use-MTS-data-routing-pipeline.rst @@ -13,7 +13,7 @@ Control metric time series (MTS) storage overhead with data routing |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/use-metrics-pipeline.rst b/infrastructure/mpm-arm/use-metrics-pipeline.rst index aafc28159..139cc8abd 100644 --- a/infrastructure/mpm-arm/use-metrics-pipeline.rst +++ b/infrastructure/mpm-arm/use-metrics-pipeline.rst @@ -13,7 +13,7 @@ Control your metric ingestion volume with rules |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| diff --git a/infrastructure/mpm-arm/view-metrics-usage-list.rst b/infrastructure/mpm-arm/view-metrics-usage-list.rst index f820c7582..c10972786 100644 --- a/infrastructure/mpm-arm/view-metrics-usage-list.rst +++ b/infrastructure/mpm-arm/view-metrics-usage-list.rst @@ -13,7 +13,7 @@ View and download the usage list for a metric |hr| -:strong:`Available in Enterprise Edition and Service Bureau` +:strong:`Available in Enterprise Edition` |hr| From 9fb039c054c781d6960e22c7965d8826b682d45d Mon Sep 17 00:00:00 2001 From: mbechtold-splunk <107698185+mbechtold-splunk@users.noreply.github.com> Date: Fri, 12 Jan 2024 12:07:47 -0600 Subject: [PATCH 18/18] Update deployments-chef.rst --- gdi/opentelemetry/deployments/deployments-chef.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/gdi/opentelemetry/deployments/deployments-chef.rst b/gdi/opentelemetry/deployments/deployments-chef.rst index 46f5bd7d0..cf2b34793 100644 --- a/gdi/opentelemetry/deployments/deployments-chef.rst +++ b/gdi/opentelemetry/deployments/deployments-chef.rst @@ -143,7 +143,7 @@ The following table shows the variables that can be configured with this Chef co - Description - Default value * - ``with_auto_instrumentation`` - - Whether to install or manage :ref:`auto-instrumentation-nodejs` and/or :ref:`auto-instrumentation-java`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. + - Whether to install or manage :ref:`auto-instrumentation-nodejs` and :ref:`auto-instrumentation-java`. When set to ``true``, the ``splunk-otel-auto-instrumentation`` deb/rpm package is downloaded and installed from the Collector repository. - ``false`` * - ``auto_instrumentation_version`` - Version of the ``splunk-otel-auto-instrumentation`` package to install, for example, ``0.50.0``. The minimum supported version is ``0.48`` for Java and ``0.87.0`` for Node.js. @@ -225,4 +225,4 @@ The cookbook accepts the attributes described in the following table: - ``false`` * - ``signalfx_dotnet_auto_instrumentation_additional_options`` - Hash of additional options to be added to the Windows registry in addition to the options above. To learn more, see :ref:`advanced-dotnet-configuration`. - - ``{}`` \ No newline at end of file + - ``{}``