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

Commit a4f41e8

Browse files
WIP
1 parent fcdb9f3 commit a4f41e8

File tree

4 files changed

+47
-42
lines changed

4 files changed

+47
-42
lines changed

_includes/gdi/auto-discovery-intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ The Splunk Distribution of the OpenTelemetry Collector can automatically identif
66

77
.. caution::
88

9-
Auto discovery of services is only available for the Collector in Linux and Kubernetes environments.
9+
Auto discovery of services is only available for the Collector in Linux and Kubernetes environments. See more at :ref:`discovery-mode-services`.
1010

11-
Zero-code instrumentation using the Collector's automatic discovery feature is only available for Java, Node.js, and .NET applications. If deployed independently from the Collector, zero-code instrumentation is supported for 8 back-end language runtimes. For more information, see :ref:`get-started-application`.
11+
Zero-code instrumentation using the Collector's automatic discovery feature is only available for Java, Node.js, and .NET applications. See more at :ref:`discovery-mode-languages`. Alternatively you can deploy zero-code instrumentation independently from the Collector for 8 back-end language runtimes. For more information, see :ref:`get-started-application`.

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

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,52 @@ For more information on APM instrumentation, see:
9898
* :ref:`get-started-nodejs`
9999
* :ref:`get-started-dotnet-otel`
100100

101+
.. _collector-linux-with-docker:
102+
103+
Collector for Linux with Docker
104+
====================================================================
105+
106+
Install the Collector in a host with Docker
107+
--------------------------------------------------------------------
108+
109+
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:
110+
111+
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:
112+
113+
.. code-block:: bash
114+
115+
$ usermod -aG docker splunk-otel-collector
116+
117+
2. When using the :new-page:`quay.io/signalfx/splunk-otel-collector <https://quay.io/repository/signalfx/splunk-otel-collector>` image, add the default container user to the required group as configured on your system, and the bind and mount the domain socket:
118+
119+
.. code-block:: bash
120+
121+
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add $(stat -c '%g' /var/run/docker.sock) quay.io/signalfx/splunk-otel-collector:latest <...>
122+
123+
# or if specifying the user:group directly
124+
$ 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 <...>
125+
126+
Use auto discovery with containers
127+
--------------------------------------------------------------------
128+
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
132+
133+
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add <socket_gid>
134+
135+
To use host bindings, run this command:
136+
137+
.. code-block:: bash
138+
139+
--set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true
140+
101141
.. _otel-installer-options-linux:
102142

103143
Options of the installer script of the Collector for Linux
104144
==================================================================
105145

106-
The Linux installer script supports the following options for the Collector, Automatic Discovery for back-end services and Fluentd.
146+
The Linux installer script supports the following options for the Collector, automatic discovery for back-end services and Fluentd.
107147

108148
To display all the configuration options supported by the script, use the ``-h`` flag.
109149

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

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -30,42 +30,3 @@ You can view the ``splunk-otel-collector`` service logs and errors in the system
3030
3131
.. note:: See :ref:`about-collector-configuration-tutorial` to learn how to configure the Collector.
3232

33-
.. _collector-linux-with-docker:
34-
35-
Collector for Linux with Docker
36-
====================================================================
37-
38-
Install the Collector in a host with Docker
39-
--------------------------------------------------------------------
40-
41-
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:
42-
43-
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:
44-
45-
.. code-block:: bash
46-
47-
$ usermod -aG docker splunk-otel-collector
48-
49-
2. When using the :new-page:`quay.io/signalfx/splunk-otel-collector <https://quay.io/repository/signalfx/splunk-otel-collector>` image, add the default container user to the required group as configured on your system, and the bind and mount the domain socket:
50-
51-
.. code-block:: bash
52-
53-
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add $(stat -c '%g' /var/run/docker.sock) quay.io/signalfx/splunk-otel-collector:latest <...>
54-
55-
# or if specifying the user:group directly
56-
$ 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 <...>
57-
58-
Use auto discovery with containers
59-
--------------------------------------------------------------------
60-
61-
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:
62-
63-
.. code-block:: bash
64-
65-
$ docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --group-add <socket_gid>
66-
67-
To use host bindings, run this command:
68-
69-
.. code-block:: bash
70-
71-
--set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true

gdi/opentelemetry/discovery-mode.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ The following diagram shows how automatic discovery finds data sources:
3737

3838
<h2>Supported host services and applications for automatic discovery</h2>
3939

40+
.. _discovery-mode-services:
41+
4042
Automatic discovery of third-party applications is supported in Linux and Kubernetes environments for the following services:
4143

4244
.. list-table::
@@ -86,6 +88,8 @@ Read more:
8688

8789
<h2>Supported language runtimes for zero-code instrumentation</h2>
8890

91+
.. _discovery-mode-languages:
92+
8993
Zero-code instrumentation via the Collector's automatic discovery is available for the following languages:
9094

9195
.. list-table::

0 commit comments

Comments
 (0)