Skip to content

Commit

Permalink
Merge pull request #1532 from splunk/repo-sync
Browse files Browse the repository at this point in the history
Pulling refs/heads/main into main
  • Loading branch information
aurbiztondo-splunk authored Sep 18, 2024
2 parents e08411d + 23283af commit 71b1284
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 12 deletions.
36 changes: 27 additions & 9 deletions gdi/opentelemetry/collector-linux/install-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,27 @@ 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 automatic discovery for back-end applications
==================================================================

You can also automatically instrument your Java, Node.js, and .NET applications along with the Collector installation. Automatic discovery removes the need to configure receivers for each back-end application. See :ref:`linux-backend-auto-discovery` for the installation instructions.

For more information on instrumentation, see:

* :ref:`get-started-java`
* :ref:`get-started-nodejs`
* :ref:`get-started-dotnet-otel`

.. _collector-linux-with-docker:

Use the Collector in a host with Docker
Collector for Linux with Docker
====================================================================

Install the Collector in a host with Docker
--------------------------------------------------------------------

If you're installing your Collector instance in a host with Docker, you need to configure a client to establish a connection with the daemon. Depending on your Docker installation and Collector deployment method, try one of these options:

1. If your daemon is listening to a domain socket (for example ``/var/run/docker.sock``), your Collector service or executable needs appropriate permissions and access. Add the ``splunk-otel-collector`` user to the Docker group as configured on your system:
Expand All @@ -107,18 +123,20 @@ If you're installing your Collector instance in a host with Docker, you need to
# or if specifying the user:group directly
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --user "splunk-otel-collector:$(stat -c '%g' /var/run/docker.sock)" quay.io/signalfx/splunk-otel-collector:latest <...>
.. _configure-auto-instrumentation:
Use auto discovery with containers
--------------------------------------------------------------------

Configure automatic discovery for back-end applications
==================================================================
If your Collector instance is running in a Docker container and the discovery targets are also containers, you need to share the Docker socket when launching the Collector container:

.. code-block:: bash
You can also automatically instrument your Java, Node.js, and .NET applications along with the Collector installation. Automatic discovery removes the need to install and configure the instrumentation SDKs separately. See :ref:`linux-backend-auto-discovery` for the installation instructions.
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add <socket_gid>
For more information on instrumentation, see:
To use host bindings, run this command:

* :ref:`get-started-java`
* :ref:`get-started-nodejs`
* :ref:`get-started-dotnet-otel`
.. code-block:: bash
--set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true
.. _otel-installer-options-linux:

Expand Down
10 changes: 7 additions & 3 deletions metrics-and-metadata/relatedcontent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,13 @@ Use the Splunk Distribution of the OpenTelemetry Collector to enable Related Con

Splunk Observability Cloud uses OpenTelemetry to correlate telemetry types. To enable this ability, your telemetry field names or metadata key names must exactly match the metadata key names used by both OpenTelemetry and Splunk Observability Cloud.

When you deploy the Splunk Distribution of the OpenTelemetry Collector with its default configuration to send your telemetry data to Splunk Observability Cloud, your metadata key names are automatically mapped correctly. To learn more about the Collector, see :ref:`otel-intro`.
Related Content works out-of-the-box when you deploy the Splunk Distribution of the OpenTelemetry Collector with its default configuration to send your telemetry data to Splunk Observability Cloud. With the default configuration the Collector automatically maps your metadata key names correctly. To learn more about the Collector, see :ref:`otel-intro`.

.. caution:: If you don't use the Splunk Distribution of OpenTelemetry Collector, or you use a non-default configuration, your telemetry data might have metadata key names that are not consistent with those used by Splunk Observability Cloud and OpenTelemetry, and Related Content might not work. In that case, you must change your metadata key names.
.. caution::

If you don't use the Splunk Distribution of OpenTelemetry Collector, or you use a non-default configuration, or you use non-Splunk OpenTelemetry, your telemetry data might have metadata key names that are not consistent with those used by Splunk Observability Cloud and OpenTelemetry, and Related Content might not work.

If you're experiencing issues with Related Content, verify your metadata key names, and update them if necessary.

Configure the Collector to enable APM Related Content
-----------------------------------------------------------------
Expand All @@ -104,7 +108,7 @@ When the field names in APM and Log Observer match, the trace and the log with t
Required Collector components
=================================================================

If you're using the Splunk Distribution of OpenTelemetry Collector, another distribution of the Collector, or the :ref:`upstream Collector <using-upstream-otel>` and want to ensure Related Content in Splunk Observability Cloud behaves correctly, verify that the SignalFx exporter is included in your configuration. This exporter aggregates the metrics from the ``hostmetrics`` receiver and must be enabled for the ``metrics`` and ``traces`` pipelines.
If you're using the Splunk Distribution of the OpenTelemetry Collector, another distribution of the Collector, or the :ref:`upstream Collector <using-upstream-otel>` and want to ensure Related Content in Splunk Observability Cloud behaves correctly, verify that the SignalFx exporter is included in your configuration. This exporter aggregates the metrics from the ``hostmetrics`` receiver and must be enabled for the ``metrics`` and ``traces`` pipelines.

The Collector uses the correlation flag of the SignalFx exporter to make relevant API calls to correlate your spans with the infrastructure metrics. This flag is enabled by default. To adjust the correlation option further, see the SignalFx exporter's options at :ref:`signalfx-exporter-settings`.

Expand Down

0 comments on commit 71b1284

Please sign in to comment.