Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
239af78
Clarify use of automatic discovery and instrumentation in main auto d…
pauljwil Oct 3, 2024
ea5a3ec
Fix left-side nav title
pauljwil Oct 4, 2024
59bd04f
Add 'and configuration' back to auto discovery
pauljwil Oct 18, 2024
e7760d2
Make changes suggested by Paulo
pauljwil Oct 25, 2024
a8a9abb
Improve TOC tree names
pauljwil Oct 25, 2024
4809958
Make requested addition
pauljwil Nov 6, 2024
30d3e1a
Change 'eight' to '8'
pauljwil Nov 6, 2024
5036614
Change eight to 8 in additional places
pauljwil Nov 6, 2024
8a733e5
WIP
aurbiztondo-splunk Nov 19, 2024
3f99c56
Edits
aurbiztondo-splunk Nov 19, 2024
7dcbb60
Fix
aurbiztondo-splunk Nov 19, 2024
028ec85
Fixes
aurbiztondo-splunk Nov 19, 2024
2962b9a
Merge branch 'main' into o11ydocs-6494
aurbiztondo-splunk Nov 20, 2024
ee3c791
Edits
aurbiztondo-splunk Nov 21, 2024
da4a389
Edits
aurbiztondo-splunk Nov 21, 2024
3eb20f7
Update gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst
aurbiztondo-splunk Nov 22, 2024
d74eecf
Update gdi/opentelemetry/automatic-discovery/discovery-linux.rst
aurbiztondo-splunk Nov 22, 2024
f0f4c1e
Edits
aurbiztondo-splunk Nov 22, 2024
a5c0c92
Feedback
aurbiztondo-splunk Nov 26, 2024
b88f0c0
Style edits
aurbiztondo-splunk Nov 26, 2024
16197f6
Merge pull request #2460 from splunk/urbiz-OD6504-ec2-details
aurbiztondo-splunk Nov 26, 2024
317553d
Merge pull request #2368 from splunk/o11ydocs-6494
aurbiztondo-splunk Nov 26, 2024
4dcacfa
Merge branch 'main' into repo-sync
aurbiztondo-splunk Nov 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions _includes/gdi/auto-discovery-intro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
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:

* 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.

* 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.

.. caution::

Auto discovery of services is only available for the Collector in Linux and Kubernetes environments.

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`.
16 changes: 6 additions & 10 deletions gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. _discovery-kubernetes:

************************************************************************
Automatic discovery and configuration for Kubernetes
Automatic discovery for Kubernetes
************************************************************************

.. meta::
: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.
: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.

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

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.

Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them.
.. include:: /_includes/gdi/auto-discovery-intro.rst

.. raw:: html

<h2>Get started</h2>

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).

To use automatic discovery for back-end applications, see :ref:`k8s-backend-auto-discovery`.
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.

To use automatic discovery with third-party applications, see :ref:`k8s-third-party`.
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.

For a walkthrough of how to use automatic discovery to instrument an application in a Kubernetees environment, see :ref:`k8s-advanced-auto-discovery-config`.
For a walkthrough of how to use automatic instrumentation to instrument an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`.
14 changes: 5 additions & 9 deletions gdi/opentelemetry/automatic-discovery/discovery-linux.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. _discovery-linux:

************************************************************************
Automatic discovery and configuration for Linux
Automatic discovery for Linux
************************************************************************

.. meta::
: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.
: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.

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

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.

Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them.
.. include:: /_includes/gdi/auto-discovery-intro.rst

.. raw:: html

<h2>Get started</h2>

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).

To use automatic discovery for back-end applications, see :ref:`linux-backend-auto-discovery`.
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.

To use automatic discovery with third-party applications, see :ref:`linux-third-party`.
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.
12 changes: 5 additions & 7 deletions gdi/opentelemetry/automatic-discovery/discovery-windows.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
.. _discovery-windows:

************************************************************************
Automatic discovery and configuration for Windows
Automatic discovery for Windows
************************************************************************

.. meta::
: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.
: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.

.. toctree::
:hidden:

Language runtimes <windows/windows-backend>

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.

Using automatic discovery, you don't have to manually instrument or configure your applications before deploying them.
.. include:: /_includes/gdi/auto-discovery-intro.rst

.. raw:: html

<h2>Get started</h2>

Automatic discovery for Windows supports .NET language runtimes.
The Collector for Windows does not support automatic discovery of services.

To use automatic discovery for back-end applications, see :ref:`windows-backend-auto-discovery`.
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.
24 changes: 12 additions & 12 deletions gdi/opentelemetry/automatic-discovery/k8s/k8s-advanced-config.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. _k8s-advanced-auto-discovery-config:

***********************************************************************
Advanced customization for automatic discovery in Kubernetes
***********************************************************************
********************************************************************************
Advanced customization for automatic discovery and instrumtenation in Kubernetes
********************************************************************************

.. meta::
:description: Learn how to customize your deployment of automatic discovery in a Kubernetes environment.
:description: Learn how to customize your deployment of automatic discovery and instrumentation in a Kubernetes environment.

Learn how to customize Splunk automatic discovery and configuration for advanced scenarios.
Learn how to customize Splunk automatic discovery and instrumentation for advanced scenarios.

Through advanced customization, you can achieve the following tasks:

Expand Down Expand Up @@ -45,7 +45,7 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v
repository: ghcr.io/signalfx/splunk-otel-java/splunk-otel-java
tag: v1.27.0

#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.

.. code-block:: bash

Expand Down Expand Up @@ -94,7 +94,7 @@ Follow these steps to activate Profiling for a language:
- name: SPLUNK_PROFILER_CALL_STACK_INTERVAL
value: 5000

#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.

.. code-block:: bash

Expand All @@ -103,7 +103,7 @@ Follow these steps to activate Profiling for a language:
Activate runtime metrics collection (Java and Node.js only)
-------------------------------------------------------------

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 :
You can activate runtime metrics collection for Java and Node.js applications running in your Kubernetes environment.

Follow these steps to activate runtime metrics collection:

Expand Down Expand Up @@ -139,7 +139,7 @@ Follow these steps to activate runtime metrics collection:
- name: SPLUNK_METRICS_ENDPOINT
value: http://$(SPLUNK_OTEL_AGENT):9943/v2/datapoint

#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.

.. code-block:: bash

Expand All @@ -150,7 +150,7 @@ Follow these steps to activate runtime metrics collection:
Use automatic discovery with gateway mode
=======================================================

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

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

Expand All @@ -176,7 +176,7 @@ Follow these steps to send data to a gateway endpoint:
exporter:
endpoint: <gateway-endpoint>

#. Reinstall the Splunk OTel Collector Chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.
#. Reinstall the Splunk OTel Collector chart with the following command. Replace <CURRENT_VERSION> with the current version of your splunk-otel-collector-chart.

.. code-block:: bash

Expand Down Expand Up @@ -207,7 +207,7 @@ Using this configuration, automatic discovery automatically sends data to a runn
Additional settings
===================================

There are many other settings you can customize in automatic discovery and configuration.
There are many other settings you can customize in automatic instrumentation.

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

Expand Down
Loading