Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 71b1284

Browse files
Merge pull request #1532 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents e08411d + 23283af commit 71b1284

File tree

2 files changed

+34
-12
lines changed

2 files changed

+34
-12
lines changed

gdi/opentelemetry/collector-linux/install-linux.rst

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,27 @@ To skip these steps and use configured repos on the target system that provide t
8585
sudo sh /tmp/splunk-otel-collector.sh --realm $SPLUNK_REALM --skip-collector-repo --skip-fluentd-repo \
8686
-- $SPLUNK_ACCESS_TOKEN
8787
88+
.. _configure-auto-instrumentation:
89+
90+
Configure automatic discovery for back-end applications
91+
==================================================================
92+
93+
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.
94+
95+
For more information on instrumentation, see:
96+
97+
* :ref:`get-started-java`
98+
* :ref:`get-started-nodejs`
99+
* :ref:`get-started-dotnet-otel`
100+
88101
.. _collector-linux-with-docker:
89102

90-
Use the Collector in a host with Docker
103+
Collector for Linux with Docker
91104
====================================================================
92105

106+
Install the Collector in a host with Docker
107+
--------------------------------------------------------------------
108+
93109
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:
94110

95111
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:
@@ -107,18 +123,20 @@ If you're installing your Collector instance in a host with Docker, you need to
107123
# or if specifying the user:group directly
108124
$ 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 <...>
109125
110-
.. _configure-auto-instrumentation:
126+
Use auto discovery with containers
127+
--------------------------------------------------------------------
111128

112-
Configure automatic discovery for back-end applications
113-
==================================================================
129+
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:
130+
131+
.. code-block:: bash
114132
115-
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.
133+
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add <socket_gid>
116134
117-
For more information on instrumentation, see:
135+
To use host bindings, run this command:
118136

119-
* :ref:`get-started-java`
120-
* :ref:`get-started-nodejs`
121-
* :ref:`get-started-dotnet-otel`
137+
.. code-block:: bash
138+
139+
--set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true
122140
123141
.. _otel-installer-options-linux:
124142

metrics-and-metadata/relatedcontent.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,13 @@ Use the Splunk Distribution of the OpenTelemetry Collector to enable Related Con
7575

7676
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.
7777

78-
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`.
78+
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`.
7979

80-
.. 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.
80+
.. caution::
81+
82+
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.
83+
84+
If you're experiencing issues with Related Content, verify your metadata key names, and update them if necessary.
8185

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

107-
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.
111+
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.
108112

109113
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`.
110114

0 commit comments

Comments
 (0)