You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: gdi/opentelemetry/auto-instrumentation/advanced-config-auto-instrumentation.rst
+56-32Lines changed: 56 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ Advanced customization for zero config auto instrumentation
7
7
.. meta::
8
8
:description: Learn how to customize Splunk zero config auto instrumentation for advanced scenarios.
9
9
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.
11
11
12
12
Through advanced customization, you can achieve the following tasks:
13
13
14
14
* :ref:`Change instrumentation version <change-zeroconfig-version>`
15
15
* :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>`
17
17
18
18
.. _change-zeroconfig-version:
19
19
@@ -26,7 +26,7 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v
26
26
#. 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``.
27
27
28
28
.. code-block:: yaml
29
-
:emphasize-lines: 12
29
+
:emphasize-lines: 14
30
30
31
31
clusterName: myCluster
32
32
splunkObservability:
@@ -37,15 +37,17 @@ By default, the Splunk Distribution of OpenTelemetry Collector uses the latest v
#. 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.
.. 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``.
51
53
@@ -60,7 +62,7 @@ See the following pages for information about previous versions for each languag
# 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
126
126
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.
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`.
178
178
179
179
.. tab:: Kubernetes
180
180
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.
182
182
183
-
Follow these steps to activate gateway mode in Kubernetes:
183
+
Follow these steps to send data to a gateway endpoint:
184
184
185
185
#. 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:
187
187
188
188
.. code-block:: yaml
189
-
:emphasize-lines: 12
189
+
:emphasize-lines: 13
190
190
191
191
clusterName: myCluster
192
192
splunkObservability:
193
-
realm: <splunk-realm>
194
-
accessToken: <splunk-access-token>
193
+
realm: <splunk-realm>
194
+
accessToken: <splunk-access-token>
195
195
environment: prd
196
196
certmanager:
197
197
enabled: true
198
198
operator:
199
199
enabled: true
200
-
201
-
gateway:
202
-
enabled: true
200
+
instrumentation:
201
+
spec:
202
+
exporter:
203
+
endpoint: <gateway-endpoint>
203
204
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.
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.
0 commit comments