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.
:description: Configure the deployment mode of the Technical Add-on OpenTelemetry Collector instance
10
+
11
+
.. toctree::
12
+
:maxdepth:5
13
+
:hidden:
14
+
15
+
The OpenTelemetry Collector has different :ref:`deployment modes <otel-deployment-mode>`:
16
+
17
+
* Host monitoring (agent): This is the default value and the simplest configuration. The Splunk Add-on for the OpenTelemetry Collector, when configured as an agent, sends data to Splunk Observability Cloud.
18
+
19
+
* Data forwarding (gateway): When configured as a gateway, your Splunk Add-on for the OpenTelemetry Collector collects data from one or more agents before forwarding it to Splunk Observability Cloud.
20
+
21
+
* As an agent that sends data to a gateway: To use a gateway instance, you create one or more instances of Splunk add-on for the OpenTelemetry Collector as agents that send data to that gateway instance.
22
+
23
+
.. _collector-addon-mode-agent:
24
+
25
+
Deploy the Splunk Add-on for the OpenTelemetry Collector as an agent
As an agent, the OpenTelemetry Collector sends data directly to Splunk Observability Cloud. This is the default configuration. Learn more at :ref:`collector-agent-mode`.
29
+
30
+
If your instance is not configured as an agent and you want to configure it as an agent, edit your inputs.conf file and update the variable ``Splunk_config`` to reflect your agent configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name is ``ta-agent-config.yaml``. If you are using a custom configuration file, provide that file name.
31
+
32
+
.. _collector-addon-mode-gateway:
33
+
34
+
Deploy the Splunk Add-on for the OpenTelemetry Collector as a gateway
If deployed as a gateway, the Collector instance can collect data from one or more Collector instances deployed as agents. The gateway instance then sends that data to Splunk Observability Cloud. Learn more at :ref:`collector-gateway-mode`.
38
+
39
+
To configure your Splunk Add-on for OpenTelemetry Collector as a gateway:
40
+
41
+
#. Edit your inputs.conf file to update the variable ``Splunk_config`` with your gateway configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name for the gateway file is ``ta-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
42
+
43
+
#. Set the ``splunk_listen_interface`` value to ``0.0.0.0`` or to the specific IP address that sends data to this gateway in ``local/inputs.conf``.
44
+
45
+
.. caution:: You must also configure one or more Collector instances as agents that send data to your new gateway.
46
+
47
+
.. _collector-addon-mode-send:
48
+
49
+
Configure Splunk Add-on for OpenTelemetry Collector as an agent that sends data to a gateway
You can set up one or more Collector instances as agents that send data to another instance that is set up as a gateway. See more at :ref:`collector-agent-to-gateway`.
53
+
54
+
To do this configure an instance that works as a gateway, and then one or more instances that operate as agents:
55
+
56
+
#. Create your gateway, if you have not already done so. See :ref:`collector-addon-mode-gateway` for more information.
57
+
58
+
#. Edit your inputs.conf file to update the variable ``Splunk_config`` to reflect your gateway configuration file name. You can find the default configuration file in your directory at ``/otelcol/config/``. The default file name for this configuration file is ``ta-agent-to-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
59
+
60
+
#. In the README directory, open ``inputs.conf.spec`` and copy the attribute for the ``splunk_gateway_url``.
61
+
62
+
#. Paste this value into ``ta-agent-to-gateway-config.yaml`` and then update the value for this setting with the gateway IP address.
Copy file name to clipboardExpand all lines: gdi/opentelemetry/collector-addon/collector-addon-install.rst
+1-54Lines changed: 1 addition & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Install the Technical Add-on for the Splunk OpenTelemetry Collector
11
11
:maxdepth:5
12
12
:hidden:
13
13
14
-
You can install the Splunk Add-on for the OpenTelemetry Collector to a :ref:`single <collector-addon-install-uf>` or to :ref:`multiple <collector-addon-install-server>` universal forwarder instances.
14
+
You can download the Splunk Add-on for the OpenTelemetry Collector from :new-page:`Splunkbase <https://splunkbase.splunk.com/app/7125>` and install it to a :ref:`single <collector-addon-install-uf>` or to :ref:`multiple <collector-addon-install-server>` universal forwarder instances.
15
15
16
16
The following applies:
17
17
@@ -94,56 +94,3 @@ Follow these steps to install the Splunk Add-on for the OpenTelemetry Collector
94
94
95
95
#. In :guilabel:`Splunk Infrastructure Monitoring`, navigate to the host where you deployed the Splunk Add-on for the OpenTelemetry Collector and select it to explore its metrics and status. For more information, see :ref:`use-navigators-imm`.
96
96
97
-
.. _collector-addon-mode:
98
-
99
-
Configure the deployment mode of your Splunk Add-on Collector instance
The OpenTelemetry Collector has different :ref:`deployment modes <otel-deployment-mode>`:
103
-
104
-
* Host monitoring (agent): This is the default value and the simplest configuration. The Splunk Add-on for the OpenTelemetry Collector, when configured as an agent, sends data to Splunk Observability Cloud.
105
-
106
-
* Data forwarding (gateway): When configured as a gateway, your Splunk Add-on for the OpenTelemetry Collector collects data from one or more agents before forwarding it to Splunk Observability Cloud.
107
-
108
-
* As an agent that sends data to a gateway: To use a gateway instance, you create one or more instances of Splunk add-on for the OpenTelemetry Collector as agents that send data to that gateway instance.
109
-
110
-
.. _collector-addon-mode-agent:
111
-
112
-
Deploy the Splunk Add-on for the OpenTelemetry Collector as an agent
As an agent, the OpenTelemetry Collector sends data directly to Splunk Observability Cloud. This is the default configuration. Learn more at :ref:`collector-agent-mode`.
116
-
117
-
If your instance is not configured as an agent and you want to configure it as an agent, edit your inputs.conf file and update the variable ``Splunk_config`` to reflect your agent configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name is ``ta-agent-config.yaml``. If you are using a custom configuration file, provide that file name.
118
-
119
-
.. _collector-addon-mode-gateway:
120
-
121
-
Deploy the Splunk Add-on for the OpenTelemetry Collector as a gateway
If deployed as a gateway, the Collector instance can collect data from one or more Collector instances deployed as agents. The gateway instance then sends that data to Splunk Observability Cloud. Learn more at :ref:`collector-gateway-mode`.
125
-
126
-
To configure your Splunk Add-on for OpenTelemetry Collector as a gateway:
127
-
128
-
#. Edit your inputs.conf file to update the variable ``Splunk_config`` with your gateway configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name for the gateway file is ``ta-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
129
-
130
-
#. Set the ``splunk_listen_interface`` value to ``0.0.0.0`` or to the specific IP address that sends data to this gateway in ``local/inputs.conf``.
131
-
132
-
.. caution:: You must also configure one or more Collector instances as agents that send data to your new gateway.
133
-
134
-
.. _collector-addon-mode-send:
135
-
136
-
Configure Splunk Add-on for OpenTelemetry Collector as an agent that sends data to a gateway
You can set up one or more Collector instances as agents that send data to another instance that is set up as a gateway. See more at :ref:`collector-agent-to-gateway`.
140
-
141
-
To do this configure an instance that works as a gateway, and then one or more instances that operate as agents:
142
-
143
-
#. Create your gateway, if you have not already done so. See :ref:`collector-addon-mode-gateway` for more information.
144
-
145
-
#. Edit your inputs.conf file to update the variable ``Splunk_config`` to reflect your gateway configuration file name. You can find the default configuration file in your directory at ``/otelcol/config/``. The default file name for this configuration file is ``ta-agent-to-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
146
-
147
-
#. In the README directory, open ``inputs.conf.spec`` and copy the attribute for the ``splunk_gateway_url``.
148
-
149
-
#. Paste this value into ``ta-agent-to-gateway-config.yaml`` and then update the value for this setting with the gateway IP address.
:description: Upgrade the Technical Add-on for the Splunk Distribution of the OpenTelemetry Collector.
9
+
10
+
.. toctree::
11
+
:maxdepth:5
12
+
:hidden:
13
+
14
+
To upgrade the Technical Add-on for the Splunk Distribution of the OpenTelemetry Collector using a deployment server follow these steps:
15
+
16
+
#. Download the upgraded version of the Splunk Add-on for the OpenTelemetry Collector from Splunkbase. See :new-page:`Splunkbase's Splunk Add-on for the OpenTelemetry Collector <https://splunkbase.splunk.com/app/7125>`.
17
+
#. Expand your downloaded file.
18
+
#. Copy the expanded Splunk_TA_otel/ folder to the :guilabel:`SPLUNK_HOME > etc > deployment apps` directory.
0 commit comments