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
Show all changes
22 commits
Select commit Hold shift + click to select a range
e07b222
Added new histogram information per SME feedback
johannahp-splunk Mar 21, 2025
b835005
Added note
johannahp-splunk Mar 21, 2025
5b495c9
Missing phrase
johannahp-splunk Mar 21, 2025
3d30fa3
Fixed table formatting
johannahp-splunk Mar 21, 2025
5c0066a
Update metricsets.rst
jcatera-splunk Mar 21, 2025
f1e6395
Added feedback from PM, put dimensions list in a table
johannahp-splunk Mar 31, 2025
aec9f48
Added feedback to separate file
johannahp-splunk Mar 31, 2025
ac11b88
Updated section location
johannahp-splunk Mar 31, 2025
4c0bd4c
Remove Fluentd
aurbiztondo-splunk Apr 10, 2025
97b7318
Fixes
aurbiztondo-splunk Apr 10, 2025
c782c47
Fix?
aurbiztondo-splunk Apr 10, 2025
a97c253
Fix?
aurbiztondo-splunk Apr 10, 2025
da8f04a
update aggregation limitations
bhillmer Apr 23, 2025
289ca17
Merge pull request #2754 from splunk/bhillmer-metrics-pipeline-intro-…
bhillmer Apr 23, 2025
f58b1d6
Update apm/span-tags/metricsets.rst
johannahp-splunk Apr 23, 2025
8985091
Merge branch 'main' into johannahp-O11YDOCS-6608-histogram-changes
johannahp-splunk Apr 23, 2025
fe3daa2
Merge pull request #2690 from splunk/johannahp-O11YDOCS-6608-histogra…
johannahp-splunk Apr 23, 2025
926a922
image
mbechtold-splunk Apr 23, 2025
acc7801
update
mbechtold-splunk Apr 23, 2025
1f5f23b
Merge pull request #2756 from splunk/mbechtold-reintroduce-diagram-gdi
adasplunk Apr 23, 2025
836e186
Merge pull request #2738 from splunk/urbiz-OD7149-remove-fluentd
aurbiztondo-splunk Apr 25, 2025
0c15597
Merge branch 'main' into repo-sync
aurbiztondo-splunk Apr 25, 2025
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
Binary file added _images/gdi/gdi-onboarding-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions _includes/requirements/collector-linux.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
The Collector supports the following Linux distributions and versions:

* Amazon Linux: 2, 2023. Log collection with Fluentd is not currently supported for Amazon Linux 2023.
* Amazon Linux: 2, 2023.
* CentOS: 7, 8, 9
* Red Hat: 7, 8, 9
* Oracle: 8, 9
* Debian: 11, 12
* SUSE: 12, 15 for version 0.34.0 or higher. Log collection with Fluentd is not currently supported.
* SUSE: 12, 15 for version 0.34.0 or higher.
* Ubuntu: 16.04, 18.04, 20.04, 22.04, and 24.04
* Rocky Linux: 8, 9
3 changes: 0 additions & 3 deletions admin/authentication/allow-services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,6 @@ If you're unable to allow all URLs as described in :ref:`allow-urls`, ensure tha
# RUM ingest endpoint
rum-ingest.<YOUR_REALM>.signalfx.com/v1/rum

# For td-agent/Fluentd on Linux and Windows
packages.treasuredata.com

# For DEB/RPM collector packages
splunk.jfrog.io
jfrog-prod-use1-shared-virginia-main.s3.amazonaws.com
Expand Down
288 changes: 149 additions & 139 deletions apm/span-tags/metricsets.rst

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion gdi/get-data-in/get-data-in.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ Use Splunk Observability Cloud to achieve full-stack observability of all your d
- :ref:`Splunk Log Observer Connect <logs-intro-logconnect>`
- :ref:`Splunk Synthetic Monitoring <intro-synthetics>` - Splunk Synthetic Monitoring does not have a data import component

This guide provides 4 chapters that guide you through the process of setting up each component of Splunk Observability Cloud.
This guide provides 4 chapters that guide you through the process of setting up each component of Splunk Observability Cloud. The following diagram shows the step-by-step process of setting up each Splunk Observability Cloud component:

.. image:: /_images/gdi/gdi-onboarding-diagram.png
:width: 80%
:alt: The step-by-step process for setting up each Splunk Observability Cloud component.


.. raw:: html

Expand Down
11 changes: 0 additions & 11 deletions gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,6 @@ Using the installer script, you can install and activate zero-code instrumentati
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>

.. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

The system-wide zero-code instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/java.conf``.

To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:
Expand Down Expand Up @@ -125,8 +123,6 @@ Using the installer script, you can install and activate zero-code instrumentati

The ``systemd`` instrumentation automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``.

.. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:

.. code-block:: bash
Expand Down Expand Up @@ -230,7 +226,6 @@ Using the installer script, you can install and activate zero-code instrumentati
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>

.. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

The system-wide zero-code instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``.

Expand All @@ -257,8 +252,6 @@ Using the installer script, you can install and activate zero-code instrumentati

The ``systemd`` zero-code instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``.

.. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example:

.. code-block:: bash
Expand Down Expand Up @@ -309,8 +302,6 @@ Using the installer script, you can install and activate zero-code instrumentati
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>

.. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

The system-wide zero-code instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/dotnet.conf``.

To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:
Expand Down Expand Up @@ -345,8 +336,6 @@ Using the installer script, you can install and activate zero-code instrumentati

The ``systemd`` instrumentation automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``.

.. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:

.. code-block:: bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ After you've installed the Collector, navigate to /etc/otel/collector to find th
.
|-- agent_config.yaml
|-- config.d
|-- fluentd
|-- gateway_config.yaml
|-- splunk-otel-collector.conf
|-- splunk-otel-collector.conf.example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,6 @@ The following table describes the variables that can be configured for this role
- The amount of allocated memory in MiB. The default value is ``512``, or 500 x 2^20 bytes, of memory .
* - ``splunk_ballast_size_mib``
- ``splunk_ballast_size_mib`` is deprecated starting on Collector version 0.97.0. If you're using it, see :ref:`how to update your configuration <collector-upgrade-memory-ballast>`.
* - ``install_fluentd``
- The option to install or manage Fluentd and dependencies for log collection. The dependencies include ``capng_c`` for activating Linux capabilities, ``fluent-plugin-systemd`` for systemd journal log collection, and the required libraries or development tools. The default value is ``false``.
* - ``td_agent_version``
- The version of td-agent (Fluentd package) that is installed. The default value is ``3.3.0`` for Debian jessie, ``3.7.1`` for Debian stretch, and ``4.3.0`` for other distros.
* - ``splunk_fluentd_config``
- The path to the Fluentd configuration file on the remote host. The default location is ``/etc/otel/collector/fluentd/fluent.conf``.
* - ``splunk_fluentd_config_source``
- The source path to a Fluentd configuration file on your control host that is uploaded and set in place of the value set in ``splunk_fluentd_config`` on remote hosts. Use this variable to submit a custom Fluentd configuration, for example, ``./custom_fluentd_config.conf``. The default value is ``""``, which means that nothing is copied and the configuration file set with ``splunk_otel_collector_config`` is used.

.. _ansible-zero-config:

Expand Down
12 changes: 0 additions & 12 deletions gdi/opentelemetry/collector-linux/deployments-linux-chef.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,18 +112,6 @@ For Linux, the cookbook accepts the attributes described in the following table:
* - ``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.
- ``false``
* - ``fluentd_version``
- Version of the td-agent (Fluentd) package to install
- ``3.7.1`` for Debian stretch and ``4.3.1`` for all other Linux distros
* - ``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 <https://puppet.com/docs/puppet/latest/types/file.html#file-attribute-source>` 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``.
- ``/etc/otel/collector/fluentd/fluent.conf``
* - ``fluentd_config_dest``
- 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:

Expand Down
12 changes: 0 additions & 12 deletions gdi/opentelemetry/collector-linux/deployments-linux-puppet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,6 @@ The class accepts the parameters described in the following table:
* - ``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``
* - ``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.
- ``false``
* - ``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 <https://puppet.com/docs/puppet/latest/types/file.html#file-attribute-source>` 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``.
- ``/etc/otel/collector/fluentd/fluent.conf``
* - ``fluentd_config_dest``
- 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``
* - ``manage_repo``
- In cases where the Collector and Fluentd apt/yum repositories are managed externally, set this to ``false`` to deactivate management of the repositories by this module. If set to ``false``, the externally managed repositories should provide the ``splunk-otel-collector`` and ``td-agent`` packages. Also, the apt (``/etc/apt/sources.list.d/splunk-otel-collector.list`` and ``/etc/apt/sources.list.d/splunk-td-agent.list``) and yum (``/etc/yum.repos.d/splunk-otel-collector.repo`` and ``/etc/yum.repos.d/splunk-td-agent.repo``) repository definition files are deleted if they exist in order to avoid any conflicts.
- ``true``

.. _puppet-zero-config:

Expand Down
15 changes: 0 additions & 15 deletions gdi/opentelemetry/collector-linux/deployments-linux-salt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,21 +110,6 @@ For Linux, the formula accepts the attributes described in the following table:
* - ``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``
* - ``install_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.
- ``false``
* - ``td_agent_version``
- Version of the td-agent (Fluentd) package to install
- ``4.3.0``
* - ``splunk_fluentd_config``
- The path to the Fluentd configuration file on the remote host.
- ``/etc/otel/collector/fluentd/fluent.conf``
* - ``splunk_fluentd_config_source``
- The source path to a Fluentd configuration file on your control host that is uploaded and set in place of the ``splunk_fluentd_config`` file on remote hosts. To use a custom Fluentd configuration file, add the configuration file into the Salt dir. For example, ``salt://templates/td_agent.conf``.
- ``""`` meaning that nothing is copied and the existing ``splunk_fluentd_config`` file is used.
* - ``fluentd_config_dest``
- 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``

.. _salt-zero-config:

Expand Down
32 changes: 0 additions & 32 deletions gdi/opentelemetry/collector-linux/install-linux-manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ See also:

* :ref:`linux-packages-post`
* :ref:`linux-packages-auto`
* :ref:`linux-packages-fluentd`

.. _linux-packages-rpm:

Expand Down Expand Up @@ -164,7 +163,6 @@ See also:

* :ref:`linux-packages-post`
* :ref:`linux-packages-auto`
* :ref:`linux-packages-fluentd`

.. _linux-packages:

Expand Down Expand Up @@ -213,7 +211,6 @@ See also:

* :ref:`linux-packages-post`
* :ref:`linux-packages-auto`
* :ref:`linux-packages-fluentd`

.. _linux-packages-post:

Expand Down Expand Up @@ -305,35 +302,6 @@ The ``splunk-otel-auto-instrumentation`` deb/rpm package installs and supports c

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

.. _linux-packages-fluentd:

Install and configure Fluentd for log collection
--------------------------------------------------------------

If you require log collection, perform the following steps to install Fluentd and forward collected log events to the Collector. This requires root privileges.

#. Install, configure, and start the Collector as described in :ref:`linux-packages-repo`. The Collector's default configuration file listens for log events on ``127.0.0.1:8006`` and sends them to Splunk Observability Cloud.

#. Install the ``td-agent`` package appropriate for the Linux distribution/version of the target system. Find the package in :new-page:`Fluentd installation <https://docs.fluentd.org/installation>`.

* If necessary, install the ``capng_c`` plugin and dependencies to enable Linux capabilities, for example ``cap_dac_read_search`` and/or ``cap_dac_override``. This requires ``td-agent`` version 4.1 or higher. See :new-page:`Linux capabilities <https://docs.fluentd.org/deployment/linux-capability>`.

* If necessary, install the ``fluent-plugin-systemd`` plugin to collect log events from the systemd journal. See :new-page:`Fluent plugin systemd <https://github.com/fluent-plugin-systemd/fluent-plugin-systemd>`.

#. Configure Fluentd to collect log events and forward them to the Collector:

* Option 1: Update the default config file at /etc/td-agent/td-agent.conf provided by the Fluentd package to collect the desired log events and forward them to ``127.0.0.1:8006``.

* Option 2: The installed Collector package provides a custom Fluentd config file /etc/otel/collector/fluentd/fluent.conf to collect log events from many popular services and forwards them to ``127.0.0.1:8006``. To use these files, you need to override the default config file path for the Fluentd service. To do this, copy the systemd environment file from /etc/otel/collector/fluentd/splunk-otel-collector.conf to /etc/systemd/system/td-agent.service.d/splunk-otel-collector.conf.

#. Ensure that the ``td-agent`` service user/group has permissions to access to the config file(s) from the previous step.

#. Restart the Fluentd service to apply the changes by running ``systemctl restart td-agent``.

#. View Fluentd service logs and errors in /var/log/td-agent/td-agent.log.

See :new-page:`Fluentd configuration <https://docs.fluentd.org/configuration>` for general Fluentd configuration details.

.. _linux-docker:

Docker
Expand Down
Loading