Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 instrumentation (formerly Zero Configuration Auto Instrumentation).
Follow this tutorial for a walkthrough of instrumenting a sample Java application in a Kubernetes environment using Splunk zero-code instrumentation (formerly Zero Configuration Auto Instrumentation).

.. raw:: html

Expand Down
2 changes: 1 addition & 1 deletion gdi/opentelemetry/collector-kubernetes/install-k8s.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ If the chart is deployed successfully, the output displays a message informing t
Use the Kubernetes Operator in OpenTelemetry
============================================================================================

Using the Splunk Helm chart, you can install the Splunk Collector along with an upstream OpenTelemetry Kubernetes Operator for Auto Instrumentation. For more information, see :ref:`discovery-kubernetes`.
Using the Splunk Helm chart, you can install the Splunk Collector along with an upstream OpenTelemetry Kubernetes Operator for zero-code instrumentation. For more information, see :ref:`discovery-kubernetes`.

This instance of the Kubernetes Operator is part of the upstream OpenTelemetry Operator project. See the :new-page:`OpenTelemetry Operator documentation <https://github.com/open-telemetry/opentelemetry-operator>` in GitHub for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ The following table describes the variables that can be configured for this role

.. _ansible-zero-config:

Configure automatic discovery for back-end applications (Linux only)
====================================================================
Configure automatic discovery with zero-code instrumentation for back-end applications (Linux only)
=================================================================================================================

You can automatically discover and instrument your back-end applications along with the Collector installation. Automatic discovery (formerly zero configuration auto instrumentation) removes the need to install and configure the SDKs separately. See :ref:`configure-auto-instrumentation` for more information.
You can automatically discover and instrument your back-end applications along with the Collector installation. Automatic discovery (formerly zero configuration auto instrumentation) removes the need to install and configure the SDKs separately. See :ref:`configure-auto-instrumentation-linux` for more information.

The following table shows the variables that you can configure for this Ansible role:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ For Linux, the formula accepts the attributes described in the following table:
Configure automatic discovery for back-end application(s)
======================================================================

You can automatically instrument your back-end applications along with the Collector installation. Automatic discovery removes the need to install and configure the OpenTelemetry SDKs separately. See :ref:`configure-auto-instrumentation` for more information.
You can automatically instrument your back-end applications along with the Collector installation. Automatic discovery removes the need to install and configure the OpenTelemetry SDKs separately. See :ref:`configure-auto-instrumentation-linux` for more information.

The following table shows the variables that can be configured for this Salt module:

Expand Down
19 changes: 10 additions & 9 deletions gdi/opentelemetry/collector-linux/install-linux-manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ To install the Collector for Linux using a RPM package, set up the package repos

yum install -y splunk-otel-collector

# Optional: install Splunk OpenTelemetry Auto Instrumentation
# Optional: install Splunk OpenTelemetry zero-code instrumentation
yum install -y splunk-otel-auto-instrumentation

.. tab:: dnf
Expand All @@ -137,7 +137,7 @@ To install the Collector for Linux using a RPM package, set up the package repos

dnf install -y splunk-otel-collector

# Optional: install Splunk OpenTelemetry Auto Instrumentation
# Optional: install Splunk OpenTelemetry zero-code instrumentation
dnf install -y splunk-otel-auto-instrumentation

.. tab:: zypper
Expand All @@ -157,7 +157,7 @@ To install the Collector for Linux using a RPM package, set up the package repos

zypper install -y splunk-otel-collector

# Optional: install Splunk OpenTelemetry Auto Instrumentation
# Optional: install Splunk OpenTelemetry zero-code instrumentation
zypper install -y splunk-otel-auto-instrumentation

See also:
Expand Down Expand Up @@ -251,7 +251,7 @@ The following applies:

.. _linux-packages-auto:

Auto Instrumentation with Debian and RPM packages
Zero-code instrumentation with Debian and RPM packages
--------------------------------------------------------------

If you prefer to install the Collector without the installer script or the Debian/RPM repositories, download the individual Debian or RPM package from the GitHub releases page and install it as shown below.
Expand All @@ -260,9 +260,9 @@ Note that:

* You need to have root privileges.
* Download the appropriate ``splunk-otel-auto-instrumentation`` Debian or RPM package for the target system in GitHub at :new-page:`Splunk OTel Collector releases <https://github.com/signalfx/splunk-otel-collector/releases>`.
* Replace ``<path to splunk-otel-auto-instrumentation deb/rpm>`` with the local path to the downloaded Auto Instrumentation package.
* Replace ``<path to splunk-otel-auto-instrumentation deb/rpm>`` with the local path to the downloaded zero-code instrumentation package.

Run the following commands to install the Auto Instrumentation package:
Run the following commands to install the zero-code instrumentation package:

.. tabs::

Expand All @@ -278,7 +278,7 @@ Run the following commands to install the Auto Instrumentation package:

rpm -ivh <path to splunk-otel-auto-instrumentation rpm>

To upgrade the Auto Instrumentation package, run:
To upgrade the zero-code instrumentation package, run:

.. tabs::

Expand All @@ -294,13 +294,14 @@ To upgrade the Auto Instrumentation package, run:

sudo rpm -Uvh <path to splunk-otel-auto-instrumentation rpm>

Auto Instrumentation agents
Zero-code instrumentation agents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``splunk-otel-auto-instrumentation`` deb/rpm package installs and supports configuration for the following Auto Instrumentation agents:
The ``splunk-otel-auto-instrumentation`` deb/rpm package installs and supports configuration for the following zero-code instrumentation agents:

* Java
* Node.js
* .Net

To learn more, see :ref:`linux-backend-auto-discovery`.

Expand Down
16 changes: 8 additions & 8 deletions gdi/opentelemetry/collector-linux/install-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ To skip these steps and use configured repos on the target system that provide t
sudo sh /tmp/splunk-otel-collector.sh --realm $SPLUNK_REALM --skip-collector-repo --skip-fluentd-repo \
-- $SPLUNK_ACCESS_TOKEN

.. _configure-auto-instrumentation:
.. _configure-auto-instrumentation-linux:

Configure automatic discovery for back-end applications
==================================================================
Expand Down Expand Up @@ -215,8 +215,8 @@ Collector
- Removes the Splunk OpenTelemetry Collector for Linux.
-

Automatic Discovery for back-end services
--------------------------------------------------------------------
Automatic discovery with zero-code instrumentation for back-end services
---------------------------------------------------------------------------------------

.. list-table::
:header-rows: 1
Expand All @@ -227,16 +227,16 @@ Automatic Discovery for back-end services
- Description
- Default value
* - ``--with[out]-instrumentation``
- Whether to install the ``splunk-otel-auto-instrumentation`` package and add the ``libsplunk.so`` shared object library to ``/etc/ld.so.preload`` to activate auto instrumentation for all supported processes on the host. Cannot be combined with the ``--with-systemd-instrumentation`` option. See :ref:`linux-backend-auto-discovery` for more information.
- Whether to install the ``splunk-otel-auto-instrumentation`` package and add the ``libsplunk.so`` shared object library to ``/etc/ld.so.preload`` to activate zero-code instrumentation for all supported processes on the host. Cannot be combined with the ``--with-systemd-instrumentation`` option. See :ref:`linux-backend-auto-discovery` for more information.
- ``--without-instrumentation``
* - ``--with[out]-systemd-instrumentation``
- Whether to install the ``splunk-otel-auto-instrumentation`` package and configure a systemd drop-in file to activate auto instrumentation for all supported applications running as systemd services. Cannot be combined with the ``--with-instrumentation`` option. See :ref:`linux-backend-auto-discovery` for more information.
- Whether to install the ``splunk-otel-auto-instrumentation`` package and configure a systemd drop-in file to activate zero-code instrumentation for all supported applications running as systemd services. Cannot be combined with the ``--with-instrumentation`` option. See :ref:`linux-backend-auto-discovery` for more information.
- ``--without-systemd-instrumentation``
* - ``--with[out]-instrumentation-sdk <sdk>``
- Whether to enable auto instrumentation for a specific language. This option takes a comma separated set of values representing supported auto-instrumentation SDKs. Currently supported values: ``java``, ``node``, and ``dotnet``. Use ``--with-instrumentation-sdk`` to enable only the specified language(s), for example ``--with-instrumentation-sdk java``. Note: .NET (``dotnet``) auto instrumentation is only supported on x86_64/amd64.
- Whether to enable zero-code instrumentation for a specific language. This option takes a comma separated set of values representing supported auto-instrumentation SDKs. Currently supported values: ``java``, ``node``, and ``dotnet``. Use ``--with-instrumentation-sdk`` to enable only the specified language(s), for example ``--with-instrumentation-sdk java``. Note: .NET (``dotnet``) zero-code instrumentation is only supported on x86_64/amd64.
- ``--with-instrumentation-sdk java,nodejs,dotnet``
* - ``--npm-path <path>``
- If Auto Instrumentation for Node.js is enabled, ``npm`` is required to install the included Splunk OpenTelemetry Auto Instrumentation for Node.js package. If ``npm`` is not found via the ``command -v npm`` shell command or if installation fails, Auto Instrumentation for Node.js will not be activated. Use this option to specify a custom path to ``npm``, for example ``--npm-path /my/path/to/npm``.
- If zero-code instrumentation for Node.js is enabled, ``npm`` is required to install the included Splunk OpenTelemetry zero-code instrumentation for Node.js package. If ``npm`` is not found via the ``command -v npm`` shell command or if installation fails, zero-code instrumentation for Node.js will not be activated. Use this option to specify a custom path to ``npm``, for example ``--npm-path /my/path/to/npm``.
- ``npm``
* - ``--deployment-environment <value>``
- Set the ``deployment.environment`` resource attribute to the specified value. If not specified, the ``Environment`` in the Splunk APM UI will appear as ``unknown`` for all instrumented applications. The resource attribute will be appended to the ``OTEL_RESOURCE_ATTRIBUTES`` environment variable.
Expand Down Expand Up @@ -266,7 +266,7 @@ Automatic Discovery for back-end services
- Activate or deactivate collection and exporting metrics for all activated SDKs that support the ``SPLUNK_METRICS_ENABLED`` environment variable.
- ``--disable-metrics``
* - ``--instrumentation-version``
- The ``splunk-otel-auto-instrumentation`` package version to install. Note: The minimum supported version for Java and Node.js auto instrumentation is 0.87.0, and the minimum supported version for .NET auto instrumentation is 0.99.0.
- The ``splunk-otel-auto-instrumentation`` package version to install. Note: The minimum supported version for Java and Node.js zero-code instrumentation is 0.87.0, and the minimum supported version for .NET zero-code instrumentation is 0.99.0.
- ``latest``

Fluentd
Expand Down