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

Commit 5c0ad58

Browse files
josh suggestions
1 parent 1a02542 commit 5c0ad58

File tree

1 file changed

+56
-32
lines changed

1 file changed

+56
-32
lines changed

gdi/opentelemetry/auto-instrumentation/advanced-config-auto-instrumentation.rst

Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Advanced customization for zero config auto instrumentation
77
.. meta::
88
:description: Learn how to customize Splunk zero config auto instrumentation for advanced scenarios.
99

10-
Learn how to customize Splunk zero config auto instrumentation for the advanced scenarios.
10+
Learn how to customize Splunk zero config auto instrumentation for advanced scenarios.
1111

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

1414
* :ref:`Change instrumentation version <change-zeroconfig-version>`
1515
* :ref:`Override auto instrumentation settings <override-zeroconfig-settings>`
16-
* :ref:`Deploy auto instrumentation in gateway mode <deploy-in-gateway>`
16+
* :ref:`Use auto instrumentation with gateway mode <deploy-in-gateway>`
1717

1818
.. _change-zeroconfig-version:
1919

@@ -26,7 +26,7 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v
2626
#. In the instrumentation language section, change the ``tag`` value to match your desired version. The following example changes the Java instrumentation version to ``v1.27.0``.
2727

2828
.. code-block:: yaml
29-
:emphasize-lines: 12
29+
:emphasize-lines: 14
3030
3131
clusterName: myCluster
3232
splunkObservability:
@@ -37,15 +37,17 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v
3737
enabled: true
3838
operator:
3939
enabled: true
40-
java:
41-
repository: ghcr.io/signalfx/splunk-otel-java/splunk-otel-java
42-
tag: v1.27.0
40+
instrumentation:
41+
spec:
42+
java:
43+
repository: ghcr.io/signalfx/splunk-otel-java/splunk-otel-java
44+
tag: v1.27.0
4345
44-
#. Reinstall the Splunk OTel Collector Chart with the following command:
46+
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace [CURRENT_VERSION] with the current version of your splunk-otel-collector-chart.
4547

4648
.. code-block:: bash
4749
48-
helm install splunk-otel-collector -f values.yaml
50+
helm upgrade splunk-otel-collector splunk-otel-collector-chart/splunk-otel-collector --version [CURRENT_VERSION] -f values.yaml
4951
5052
.. note:: If you don't see the ``java`` field in your ``values.yaml`` file, then you have to add the field and the ``repository`` value before changing the version. The repository value is always ``ghcr.io/signalfx/splunk-otel-java/splunk-otel-java``.
5153

@@ -60,7 +62,7 @@ See the following pages for information about previous versions for each languag
6062
Override auto instrumentation settings
6163
====================================================
6264

63-
You can override default auto instrumentation settings to use features such as profiling and runtime metrics collection.
65+
You can override default auto instrumentation settings to use features for profiling and runtime metrics collection.
6466

6567
Activate AlwaysOn Profiling
6668
----------------------------------------------------
@@ -113,22 +115,20 @@ You can activate CPU and memory profiling by updating the environment variables
113115
instrumentation:
114116
spec:
115117
nodejs:
116-
repository: ghcr.io/signalfx/splunk-otel-js/splunk-otel-js
117-
tag: v2.7.0
118118
env:
119-
# Activates AlwaysOn Profiling for Node.js
120-
- name: SPLUNK_PROFILER_ENABLED
121-
value: true
122-
# Samples call stacks from a 5000 millisecond interval.
123-
# If excluded, samples from a 10000 millisecond interval by default.
124-
- name: SPLUNK_PROFILER_CALL_STACK_INTERVAL
125-
value: 5000
119+
# Activates AlwaysOn Profiling for Node.js
120+
- name: SPLUNK_PROFILER_ENABLED
121+
value: true
122+
# Samples call stacks from a 5000 millisecond interval.
123+
# If excluded, samples from a 10000 millisecond interval by default.
124+
- name: SPLUNK_PROFILER_CALL_STACK_INTERVAL
125+
value: 5000
126126
127-
#. Reinstall the Splunk OTel Collector Chart with the following command:
127+
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace [CURRENT_VERSION] with the current version of your splunk-otel-collector-chart.
128128

129129
.. code-block:: bash
130130
131-
helm install splunk-otel-collector -f values.yaml
131+
helm upgrade splunk-otel-collector splunk-otel-collector-chart/splunk-otel-collector --version [CURRENT_VERSION] -f values.yaml
132132
133133
Activate runtime metrics collection (Linux only)
134134
----------------------------------------------------
@@ -155,7 +155,7 @@ To activate runtime metrics collection for an individual language, follow these
155155

156156
.. _deploy-in-gateway:
157157

158-
Use auto instrumentation in gateway mode
158+
Use auto instrumentation with gateway mode
159159
===========================================================
160160

161161
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.
@@ -178,34 +178,58 @@ To learn more about the gateway mode, see :ref:`collector-gateway-mode`.
178178

179179
.. tab:: Kubernetes
180180

181-
You can change the Collector deployment mode in Kubernetes. If you change the deployment mode to gateway, the instrumentation automatically routes data to the gateway deployment.
181+
You can send data to an endpoint of a Collector instance running in gateway mode.
182182

183-
Follow these steps to activate gateway mode in Kubernetes:
183+
Follow these steps to send data to a gateway endpoint:
184184

185185
#. Open the values.yaml file.
186-
#. Set the ``gateway.enabled`` value to ``true``. The following example activates gateway mode:
186+
#. Set the ``operator.instrumentation.spec.exporter.endpoint`` value to the gateway endpoint. For example:
187187

188188
.. code-block:: yaml
189-
:emphasize-lines: 12
189+
:emphasize-lines: 13
190190
191191
clusterName: myCluster
192192
splunkObservability:
193-
realm: <splunk-realm>
194-
accessToken: <splunk-access-token>
193+
realm: <splunk-realm>
194+
accessToken: <splunk-access-token>
195195
environment: prd
196196
certmanager:
197197
enabled: true
198198
operator:
199199
enabled: true
200-
201-
gateway:
202-
enabled: true
200+
instrumentation:
201+
spec:
202+
exporter:
203+
endpoint: <gateway-endpoint>
203204
204-
#. Reinstall the Splunk OTel Collector Chart with the following command:
205+
#. Reinstall the Splunk OTel Collector Chart with the following command. Replace [CURRENT_VERSION] with the current version of your splunk-otel-collector-chart.
205206

206207
.. code-block:: bash
207208
208-
helm install splunk-otel-collector -f values.yaml
209+
helm upgrade splunk-otel-collector splunk-otel-collector-chart/splunk-otel-collector --version [CURRENT_VERSION] -f values.yaml
210+
211+
You can also automatically send data to a deployed gateway endpoint by setting ``agent.enabled: false`` and ``gateway.enabled: true`` in your values.yaml file. For example:
212+
213+
.. code-block:: yaml
214+
:emphasize-lines: 12, 14
215+
216+
clusterName: myCluster
217+
splunkObservability:
218+
realm: <splunk-realm>
219+
accessToken: <splunk-access-token>
220+
environment: prd
221+
certmanager:
222+
enabled: true
223+
operator:
224+
enabled: true
225+
226+
agent:
227+
enabled: false
228+
gateway:
229+
enabled: true
230+
231+
Using this configuration, auto instrumentation automatically sends data to a running gateway endpoint.
232+
209233

210234
Additional settings
211235
===================================

0 commit comments

Comments
 (0)