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

Commit 317553d

Browse files
Merge pull request #2368 from splunk/o11ydocs-6494
Clarify use of automatic discovery and instrumentation in main auto discovery section
2 parents 16197f6 + f0f4c1e commit 317553d

15 files changed

+144
-158
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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:
2+
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`.
Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.. _discovery-kubernetes:
22

33
************************************************************************
4-
Automatic discovery and configuration for Kubernetes
4+
Automatic discovery for Kubernetes
55
************************************************************************
66

77
.. meta::
8-
:description: Get started with automatic discovery and configuration for Kubernetes environments. Deploy automatic discovery to automatically find applications running in your environment and send data from them to Splunk Observability Cloud.
8+
:description: Get started with automatic discovery and instrumentation for Kubernetes environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your environment and send data from them to Splunk Observability Cloud.
99

1010
.. toctree::
1111
:hidden:
@@ -15,18 +15,14 @@ Automatic discovery and configuration for Kubernetes
1515
Advanced customization <k8s/k8s-advanced-config>
1616
k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial
1717

18-
Automatic discovery and configuration for Kubernetes automatically finds applications running in your Kubernetes environments and captures telemetry data from them. The Splunk Distribution of OpenTelemetry Collector receives this data and sends it to Splunk Observability Cloud.
19-
20-
Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them.
18+
.. include:: /_includes/gdi/auto-discovery-intro.rst
2119

2220
.. raw:: html
2321

2422
<h2>Get started</h2>
2523

26-
Automatic discovery for Kubernetes supports both back-end applications (such as Java and Node.js) as well as third-party applications (such as databases and web servers).
27-
28-
To use automatic discovery for back-end applications, see :ref:`k8s-backend-auto-discovery`.
24+
To enable the Collector's zero-code instrumentation of back-end applications written in Java, Node.js, and .NET see :ref:`k8s-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately.
2925

30-
To use automatic discovery with third-party applications, see :ref:`k8s-third-party`.
26+
To use the Collector's automatic discovery of third-party applications in Kubernetes environments see :ref:`k8s-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector.
3127

32-
For a walkthrough of how to use automatic discovery to instrument an application in a Kubernetees environment, see :ref:`k8s-advanced-auto-discovery-config`.
28+
For a walkthrough of how to use automatic instrumentation to instrument an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`.
Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.. _discovery-linux:
22

33
************************************************************************
4-
Automatic discovery and configuration for Linux
4+
Automatic discovery for Linux
55
************************************************************************
66

77
.. meta::
8-
:description: Get started with automatic discovery and configuration for Linux environments. Deploy automatic discovery to automatically find applications running in your Linux environment and send data from them to Splunk Observability Cloud.
8+
:description: Get started with automatic discovery and instrumentation for Linux environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud.
99

1010
.. toctree::
1111
:hidden:
@@ -14,16 +14,12 @@ Automatic discovery and configuration for Linux
1414
Third-party applications <linux/linux-third-party>
1515
Advanced customization <linux/linux-advanced-config>
1616

17-
Automatic discovery and configuration for Linux automatically finds applications running in your Linux environment and captures telemetry data from them. The Splunk Distribution of OpenTelemetry Collector receives this data and sends it to Splunk Observability Cloud.
18-
19-
Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them.
17+
.. include:: /_includes/gdi/auto-discovery-intro.rst
2018

2119
.. raw:: html
2220

2321
<h2>Get started</h2>
2422

25-
Automatic discovery for Linux supports both back-end applications (such as Java and Node.js) as well as third-party applications (such as databases, web servers, and message queues).
26-
27-
To use automatic discovery for back-end applications, see :ref:`linux-backend-auto-discovery`.
23+
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.
2824

29-
To use automatic discovery with third-party applications, see :ref:`linux-third-party`.
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.
Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
.. _discovery-windows:
22

33
************************************************************************
4-
Automatic discovery and configuration for Windows
4+
Automatic discovery for Windows
55
************************************************************************
66

77
.. meta::
8-
:description: Get started with automatic discovery and configuration for Windows environments. Deploy automatic discovery to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud.
8+
:description: Get started with automatic instrumentation for Windows environments. Deploy automatic instrumentation to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud.
99

1010
.. toctree::
1111
:hidden:
1212

1313
Language runtimes <windows/windows-backend>
1414

15-
Automatic discovery and configuration for Windows automatically finds applications running in your Windows environment and captures telemetry data from them. The Splunk Distribution of OpenTelemetry Collector receives this data and sends it to Splunk Observability Cloud.
16-
17-
Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them.
15+
.. include:: /_includes/gdi/auto-discovery-intro.rst
1816

1917
.. raw:: html
2018

2119
<h2>Get started</h2>
2220

23-
Automatic discovery for Windows supports .NET language runtimes.
21+
The Collector for Windows does not support automatic discovery of services.
2422

25-
To use automatic discovery for back-end applications, see :ref:`windows-backend-auto-discovery`.
23+
To enable the Collector's zero-code instrumentation of back-end applications written in .NET see :ref:`windows-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately.

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. _k8s-advanced-auto-discovery-config:
22

3-
***********************************************************************
4-
Advanced customization for automatic discovery in Kubernetes
5-
***********************************************************************
3+
********************************************************************************
4+
Advanced customization for automatic discovery and instrumtenation in Kubernetes
5+
********************************************************************************
66

77
.. meta::
8-
:description: Learn how to customize your deployment of automatic discovery in a Kubernetes environment.
8+
:description: Learn how to customize your deployment of automatic discovery and instrumentation in a Kubernetes environment.
99

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

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

@@ -45,7 +45,7 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v
4545
repository: ghcr.io/signalfx/splunk-otel-java/splunk-otel-java
4646
tag: v1.27.0
4747
48-
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
48+
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
4949

5050
.. code-block:: bash
5151
@@ -94,7 +94,7 @@ Follow these steps to activate Profiling for a language:
9494
- name: SPLUNK_PROFILER_CALL_STACK_INTERVAL
9595
value: 5000
9696
97-
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
97+
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
9898

9999
.. code-block:: bash
100100
@@ -103,7 +103,7 @@ Follow these steps to activate Profiling for a language:
103103
Activate runtime metrics collection (Java and Node.js only)
104104
-------------------------------------------------------------
105105

106-
You can activate runtime metrics collection for Java and Node.js applications running in your Kubernetes environment. To learn more about runtime metrics collection, see :
106+
You can activate runtime metrics collection for Java and Node.js applications running in your Kubernetes environment.
107107

108108
Follow these steps to activate runtime metrics collection:
109109

@@ -139,7 +139,7 @@ Follow these steps to activate runtime metrics collection:
139139
- name: SPLUNK_METRICS_ENDPOINT
140140
value: http://$(SPLUNK_OTEL_AGENT):9943/v2/datapoint
141141
142-
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
142+
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
143143

144144
.. code-block:: bash
145145
@@ -150,7 +150,7 @@ Follow these steps to activate runtime metrics collection:
150150
Use automatic discovery with gateway mode
151151
=======================================================
152152

153-
The Splunk OTel Collector Chart uses the agent mode by default. Activating gateway mode deploys an instance of the OpenTelemetry Collector in a separate container, and this instance collects data from the entire cluster.
153+
The Splunk OTel Collector chart uses the agent mode by default. Activating gateway mode deploys an instance of the OpenTelemetry Collector in a separate container, and this instance collects data from the entire cluster.
154154

155155
To learn more about the gateway mode, see :ref:`collector-gateway-mode`.
156156

@@ -176,7 +176,7 @@ Follow these steps to send data to a gateway endpoint:
176176
exporter:
177177
endpoint: <gateway-endpoint>
178178
179-
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
179+
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
180180

181181
.. code-block:: bash
182182
@@ -207,7 +207,7 @@ Using this configuration, automatic discovery automatically sends data to a runn
207207
Additional settings
208208
===================================
209209

210-
There are many other settings you can customize in automatic discovery and configuration.
210+
There are many other settings you can customize in automatic instrumentation.
211211

212212
For a list of settings that you can change for each language, see the following resources:
213213

0 commit comments

Comments
 (0)