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

Commit ee73796

Browse files
Merge pull request #2481 from splunk/urbiz-OD6472-autodiscovery-linux
[6472]: AD for Linux improvements
2 parents f5c6739 + 8e47fa0 commit ee73796

File tree

9 files changed

+56
-27
lines changed

9 files changed

+56
-27
lines changed
Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
The Splunk Distribution of the OpenTelemetry Collector can automatically identify data sources and collect metrics and traces to send them to Splunk Observability Cloud. With automatic discovery and zero-code instrumentation you don't need to manually configure the Splunk Distribution of the OpenTelemetry Collector or your applications before deploying them:
1+
Automatic discovery detects and collects signal data from third-party services, such as databases and web servers. Through auto discovery the Collector automatically generates a configuration snipet that you can modify and incorporate into your existing configuration to retrieve your services' data. Auto discovery of services is only available for the Collector in Linux and Kubernetes environments.
22

3-
* Automatic discovery detects and collects signal data from third-party services, such as databases and web servers. Through auto discovery the Collector automatically generates a configuration snipet that you can modify and incorporate into your existing configuration to retrieve your services' data.
4-
5-
* With automatic discovery you can also enable zero-code instrumentation, which allows the Collector to retrieve data from application language runtimes without having to modify the source application code or adding any new installation or configuration steps. With this option you won't have to install and configure your instrumentation agents separately.
6-
7-
.. caution::
8-
9-
Auto discovery of services is only available for the Collector in Linux and Kubernetes environments.
10-
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`.
3+
With automatic discovery you can also enable zero-code instrumentation of back-end applications, which allows the Collector to retrieve data from application language runtimes without having to modify the source application code or adding any new installation or configuration steps. With this option you won't have to install and configure your instrumentation agents separately. Zero-code instrumentation using the Collector's automatic discovery feature is only available for the Java, Node.js, and .NET language runtimes. Alternatively you can deploy zero-code instrumentation independently from the Collector for 8 back-end languages, as described in :ref:`get-started-application`.

gdi/opentelemetry/automatic-discovery/discovery-linux.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,6 @@ Automatic discovery for Linux
2222

2323
To enable the Collector's zero-code instrumentation of back-end applications written in Java, Node.js, and .NET see :ref:`linux-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately.
2424

25-
To use the Collector's automatic discovery and configuration of third-party applications in Linux environments see :ref:`linux-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector.
25+
To use the Collector's automatic discovery and configuration of third-party applications in Linux environments see :ref:`linux-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector.
26+
27+
For advanced auto discovery configuration see :ref:`linux-advanced-auto-discovery-config`.

gdi/opentelemetry/automatic-discovery/linux/linux-advanced-config.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
.. _linux-advanced-auto-discovery-config:
22

33
*****************************************************************************
4-
Advanced customization for automatic discovery and instrumentation in Linux
4+
Advanced customization for automatic discovery in Linux
55
*****************************************************************************
66

77
.. meta::
88
:description: Learn how to customize your deployment of automatic discovery and instrumentation in a Linux environment.
99

10-
Learn how to customize automatic discovery and instrumentation for advanced scenarios.
10+
Learn how to customize automatic discovery and zero-code instrumentation for advanced scenarios.
1111

1212
Through advanced customization, you can achieve the following tasks:
1313

1414
* :ref:`Override automatic instrumentation settings <override-default-settings-linux>`
1515
* :ref:`Use automatic discovery with gateway mode <use-with-gateway-linux>`
1616
* :ref:`Customize discovery settings for third-party applications <customize-third-party-settings-linux>`
1717

18-
.. note:: For advanced customization options in Kubernetes, see :ref:`k8s-advanced-auto-discovery-config`.
19-
2018
.. _override-default-settings-linux:
2119

2220
Override default automatic instrumentation settings
@@ -76,6 +74,8 @@ To activate runtime metrics collection for an individual language, follow these
7674
#. Set the environment variable ``SPLUNK_METRICS_ENABLED=true``.
7775
#. Restart your applications.
7876

77+
78+
7979
.. _use-with-gateway-linux:
8080

8181
Use automatic discovery with gateway mode

gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,32 @@ To install, configure and use the Splunk Distribution of the Collector for Kuber
3737
<h2>Install the Collector for Kubernetes<a name="k8s-install" class="headerlink" href="#k8s-install" title="Permalink to this headline">¶</a></h2>
3838
</embed>
3939

40-
To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using the Helm chart, read and follow these docs:
40+
To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using the Helm chart read and follow these docs:
4141

4242
* :ref:`otel-install-k8s`
4343
* :ref:`kubernetes-helm-architecture`
4444
* :ref:`kubernetes-helm-releases`
4545

46+
.. note:: By default you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`.
47+
4648
Optionally, you can also:
4749

4850
* :ref:`otel-install-k8s-manifests`
4951
* :ref:`Deploy the Collector as an AWS EKS Add-on <install-k8s-addon-eks>`
50-
51-
.. note:: By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`.
52+
* Deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`
5253

5354
.. raw:: html
5455

5556
<embed>
5657
<h2>Configure the Collector for Kubernetes<a name="k8s-configure" class="headerlink" href="#k8s-configure" title="Permalink to this headline">¶</a></h2>
5758
</embed>
5859

59-
To configure the Collector, including adding additional components or activating automatic discovery, see:
60+
.. note:: To deploy the Collector for Kubernetes and automatically find services and applications running in your environment refer to :ref:`discovery-kubernetes`.
61+
62+
To configure the Collector see:
6063

6164
* :ref:`otel-kubernetes-config`
6265
* :ref:`kubernetes-config-add`
63-
* :ref:`discovery-mode-k8s`
6466
* :ref:`kubernetes-config-logs`
6567
* :ref:`otel-kubernetes-config-advanced`
6668

@@ -72,7 +74,7 @@ To configure the Collector, including adding additional components or activating
7274
<h2>Upgrade, uninstall and troubleshoot<a name="k8s-ts" class="headerlink" href="#k8s-ts" title="Permalink to this headline">¶</a></h2>
7375
</embed>
7476

75-
To upgrade or uninstall, see:
77+
To upgrade or uninstall the Collector see:
7678

7779
* :ref:`otel-kubernetes-upgrade`
7880
* :ref:`otel-kubernetes-uninstall`

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

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,26 @@ Get started with the Collector for Linux
2424

2525
To install and configure the Splunk Distribution of the OpenTelemetry Collector for Linux, follow these docs:
2626

27+
.. raw:: html
28+
29+
<embed>
30+
<h2>Install the Collector for Linux<a name="linux-install" class="headerlink" href="#linux-install" title="Permalink to this headline">¶</a></h2>
31+
</embed>
32+
33+
To install the Splunk Distribution of the OpenTelemetry Collector for Linux you have the following options:
34+
2735
* :ref:`otel-install-linux`
2836
* :ref:`otel-install-linux-manual`
2937
* :ref:`otel-install-linux-tools`
38+
* You can also deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
39+
40+
.. raw:: html
41+
42+
<embed>
43+
<h2>Configure the Collector for Linux<a name="linux-configure" class="headerlink" href="#linux-configure" title="Permalink to this headline">¶</a></h2>
44+
</embed>
3045

31-
.. note:: You can also deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
46+
.. note:: To deploy the Collector for Linux and automatically find services and applications running in your environment refer to :ref:`discovery-linux`.
3247

3348
See the default settings and configuration options at:
3449

@@ -39,11 +54,23 @@ See the default settings and configuration options at:
3954

4055
.. include:: /_includes/gdi/collector-common-options.rst
4156

42-
To upgrade or uninstall, see:
57+
.. raw:: html
58+
59+
<embed>
60+
<h2>Upgrade, uninstall and troubleshoot<a name="linux-ts" class="headerlink" href="#linux-ts" title="Permalink to this headline">¶</a></h2>
61+
</embed>
62+
63+
To upgrade or uninstall the Collector see:
4364

4465
* :ref:`otel-linux-upgrade`
4566
* :ref:`otel-linux-uninstall`
4667

47-
.. note:: If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting`.
68+
If you have any installation or configuration issues refer to :ref:`otel-troubleshooting`.
69+
70+
.. raw:: html
71+
72+
<embed>
73+
<h2>Tutorials<a name="linux-tutorials" class="headerlink" href="#linux-tutorials" title="Permalink to this headline">¶</a></h2>
74+
</embed>
4875

4976
For a walkthrough of common tasks related to the OpenTelemetry Collector for Linux see: :ref:`about-collector-configuration-tutorial`.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Configure automatic discovery for back-end applications
9292

9393
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.
9494

95-
For more information on instrumentation, see:
95+
For more information on APM instrumentation, see:
9696

9797
* :ref:`get-started-java`
9898
* :ref:`get-started-nodejs`
@@ -143,7 +143,7 @@ To use host bindings, run this command:
143143
Options of the installer script of the Collector for Linux
144144
==================================================================
145145

146-
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.
147147

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ You can view the ``splunk-otel-collector`` service logs and errors in the system
2929
sudo journalctl -u splunk-otel-collector
3030
3131
.. note:: See :ref:`about-collector-configuration-tutorial` to learn how to configure the Collector.
32+

gdi/opentelemetry/collector-windows/collector-windows-intro.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Windows, f
2828
* :ref:`otel-install-windows-msi`
2929
* :ref:`otel-install-windows-tools`
3030
* :ref:`otel-install-windows-manual`
31+
* You can also deploy the Collector using the Technical Add-on, which provides out-of-the box Collector content and configuration. Learn more at :ref:`collector-addon-intro`.
3132

3233
See the default settings and configuration options at:
3334

@@ -38,6 +39,8 @@ See the default settings and configuration options at:
3839

3940
.. include:: /_includes/gdi/collector-common-options.rst
4041

42+
To automatically find services and applications running in your Windows environment and send data from them to Splunk Observability Cloud refer to :ref:`discovery-windows`.
43+
4144
To upgrade or uninstall, see:
4245

4346
* :ref:`otel-windows-upgrade`

gdi/opentelemetry/discovery-mode.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Automatic discovery of apps and services
1414
Linux <automatic-discovery/discovery-linux>
1515
Windows <automatic-discovery/discovery-windows>
1616

17-
.. include:: /_includes/gdi/auto-discovery-intro.rst
17+
The Splunk Distribution of the OpenTelemetry Collector can automatically identify data sources and collect metrics and traces to send them to Splunk Observability Cloud. With automatic discovery and zero-code instrumentation you don't need to manually configure the Splunk Distribution of the OpenTelemetry Collector or your applications before deploying them.
1818

1919
The following diagram shows how automatic discovery finds data sources:
2020

@@ -33,6 +33,8 @@ The following diagram shows how automatic discovery finds data sources:
3333

3434
X --> Y --> Z
3535

36+
.. include:: /_includes/gdi/auto-discovery-intro.rst
37+
3638
.. raw:: html
3739

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

0 commit comments

Comments
 (0)