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: Use Chef to install and configure the OpenTelemetry Collector to collect metrics, traces, and logs from Linux and Windows machines and send data to Splunk Observability Cloud.
9
+
10
+
:description: Use Chef to install and configure the OpenTelemetry Collector to collect metrics, traces, and logs from Linux and Windows machines and send data to Splunk Observability Cloud.
9
11
10
12
Chef is a configuration management technology used to manage infrastructure on physical or virtual machines. Chef uses cookbooks to define a scenario.
11
13
@@ -31,16 +33,6 @@ The following Linux distributions and versions:
31
33
* SUSE: 12, 15 (Note: Only for Collector versions 0.34.0 or higher. Log collection with Fluentd not currently supported.)
32
34
* Ubuntu: 18.04, 20.04, 22.04
33
35
34
-
Windows
35
-
---------------------
36
-
37
-
The following Windows versions. All versions require using PowerShell 3.0 or newer.
38
-
39
-
* Windows Server 2019 64-bit
40
-
* Windows Server 2022 64-bit
41
-
42
-
.. caution:: On Windows, the Collector is installed as a Windows service and its environment variables are set at the service scope, so they're only available to the Collector service and not to the entire machine.
You can automatically instrument your .NET applications along with the Collector installation using automatic discovery. Automatic discovery removes the need to install and configure the SignalFx .NET agent separately. See :ref:`discovery_mode` for more information.
193
-
194
-
The cookbook accepts the attributes described in the following table:
195
-
196
-
.. list-table::
197
-
:widths: 20 50 30
198
-
:header-rows: 1
199
-
200
-
* - Name
201
-
- Description
202
-
- Default value
203
-
* - ``with_signalfx_dotnet_instrumentation``
204
-
- Whether to install or manage automatic discovery for .NET. When set to ``true``, the ``signalfx-dotnet-tracing`` MSI package will be downloaded and installed, and the Windows registry will be updated based on other configuration options. To learn more, see :ref:`windows-backend-auto-discovery`
- Specify the URL to download the MSI from a custom host, for example ``https://my.host/signalfx-dotnet-tracing-1.0.0-x64.msi``. If specified, the ``signalfx_dotnet_auto_instrumentation_version`` option is ignored.
- By default, the ``iisreset.exe`` command will be executed after installation/configuration in order for any changes to take effect for IIS applications. Set this option to ``false`` to skip this step if IIS is managed separately or is not applicable.
- Whether to configure automatic discovery for all .NET applications on the node. When set to ``true``, all attributes and environment variables are added to the ``HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment`` registry key.
- Sets the deployment environment variable that is reported to Splunk APM, for example ``production``. The value is assigned to the ``SIGNALFX_ENV`` environment variable in the Windows registry.
- Sets the service name for the instrumented application, for example, ``my-service``. The value is assigned to the ``SIGNALFX_SERVICE_NAME`` environment variable in the Windows registry.
- Activates or deactivates AlwaysOn Profiling. The value will be assigned to the ``SIGNALFX_PROFILER_ENABLED`` environment variable in the Windows registry.
- Activates or deactivates AlwaysOn Memory Profiling. The value will be assigned to the ``SIGNALFX_PROFILER_MEMORY_ENABLED`` environment variable in the Windows registry.
- Hash of additional options to be added to the Windows registry in addition to the options above. To learn more, see :ref:`advanced-dotnet-configuration`.
Use ``collector_additional_env_vars`` to include any additional environment variables from the Collector configuration file for the Collector's service. ``{}`` by default.
238
-
239
-
For example, if the Collector's configuration file includes references to ``${MY_CUSTOM_VAR1}`` and ``${MY_CUSTOM_VAR2}``, specify the following to allow the Collector service to expand these variables:
On Linux, the variables/values will be added to the ``/etc/otel/collector/splunk-otel-collector.conf`` systemd environment file.
181
+
Next steps
182
+
==================================
246
183
247
-
On Windows, the variables/values will be added to the Environment value under the ``HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\splunk-otel-collector`` registry key.
:description: Deploy the Splunk Observability Cloud OpenTelemetry Collector using a Salt formula.
9
+
10
+
:description: Deploy the Splunk Observability Cloud OpenTelemetry Collector for Linux using a Salt formula.
9
11
10
12
You can use a formula to install and configure the Collector to collect metrics, traces, and logs from Linux machines and send data to Splunk Observability Cloud. See the :new-page:`GitHub repository <https://github.com/signalfx/splunk-otel-collector/tree/main/deployments/salt>` to download the Salt module.
11
13
@@ -20,26 +22,26 @@ You need the following resources to use Salt:
* Check exposed ports to make sure your environment doesn't have conflicts. You can change ports in the Collector configuration. See :ref:`otel-exposed-endpoints` for more information.
22
24
23
-
Linux
25
+
Supported Linux versions
24
26
------------------------
25
-
Currently, we support the following Linux distributions and versions:
27
+
28
+
The following Linux distributions and versions are supported:
26
29
27
30
* Amazon Linux: 2, 2023. Log collection with Fluentd isn't supported for Amazon Linux 2023.
28
31
* CentOS, Red Hat, Oracle: 7, 8, 9
29
32
* Debian: 9, 10, 11
30
33
* SUSE: 12, 15 (Note: Only for Collector versions 0.34.0 or higher. Log collection with Fluentd not currently supported.)
31
34
* Ubuntu: 18.04, 20.04, 22.04
32
35
33
-
Getting started
36
+
Get started
34
37
==========================
35
38
36
-
Salt uses key-value stores known as "pillars" for user-defined data to be made available to a "minion". Salt defines a minion as a server running a Salt minion daemon which can listen to commands from a manager and run the requested tasks. Generally, minions are servers which are to be controlled using Salt.
39
+
Salt uses key-value stores known as "pillars" for user-defined data to be made available to a "minion". Salt defines a minion as a server running a Salt minion daemon which can listen to commands from a manager and run the requested tasks. Generally, minions are servers controlled using Salt.
37
40
38
41
You can configure all attributes in the ``splunk-otel-collector`` pillar. For example:
39
42
40
43
.. code-block:: yaml
41
44
42
-
43
45
splunk-otel-collector:
44
46
splunk_access_token: "MY_ACCESS_TOKEN"
45
47
splunk_realm: "SPLUNK_REALM"
@@ -123,7 +125,7 @@ For Linux, the formula accepts the attributes described in the following table:
123
125
124
126
.. _salt-zero-config:
125
127
126
-
Configure automatic discovery for back-end application(s) (Linux only)
128
+
Configure automatic discovery for back-end application(s)
You can automatically instrument your back-end applications along with the Collector installation. Automatic discovery removes the need to install and configure the OpenTelemetry SDKs separately. See :ref:`configure-auto-instrumentation` for more information.
@@ -170,3 +172,8 @@ The following table shows the variables that can be configured for this Salt mod
170
172
* - ``auto_instrumentation_enable_metrics``
171
173
- Activates or deactivates instrumentation metrics.
:description: Describes how to install the Splunk Distribution of the OpenTelemetry Collector for Windows using deployment tools.
10
+
11
+
.. toctree::
12
+
:maxdepth:4
13
+
:hidden:
14
+
15
+
Ansible for Linux <deployments-linux-ansible.rst>
16
+
Chef for Linux <deployments-linux-chef.rst>
17
+
Puppet for Linux <deployments-linux-puppet.rst>
18
+
Salt for Linux <deployments-linux-salt.rst>
19
+
20
+
The Splunk Distribution of the OpenTelemetry Collector for Linux is a package that provides integrated collection and
21
+
forwarding for all data types. Read on to see how to install it using several deployment tools.
22
+
23
+
.. note::
24
+
25
+
The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`linux-config-ootb`. To modify this configuration, refer to :ref:`otel-linux-config`.
26
+
27
+
Alternatively, you can also install the Collector for Linux:
28
+
29
+
* Using the installer script. See :ref:`otel-install-linux`.
30
+
* Manually. See :ref:`otel-install-linux-manual`.
31
+
32
+
.. _install-linux-tools-prereqs:
33
+
34
+
.. raw:: html
35
+
36
+
<embed>
37
+
<h2>Prerequisites<aname="install-windows-tools-prereqs"class="headerlink"href="#install-windows-tools-prereqs"title="Permalink to this headline">¶</a></h2>
<h2>Available deployment tools<aname="install-linux-tools-prereqs"class="headerlink"href="#install-linux-tools-prereqs"title="Permalink to this headline">¶</a></h2>
46
+
</embed>
47
+
48
+
The following deployment tools to install the Splunk Distribution of the OpenTelemetry Collector are available:
49
+
50
+
* Use Splunk's Ansible role to install the package configured to collect data (metrics, traces, and logs) from Linux machines and send it to Splunk Observability Cloud. See :ref:`deployment-linux-ansible` for the instructions to download and customize the role.
51
+
* Use Splunk's cookbook to install the Collector with Chef. See :ref:`deployments-linux-chef` for the installation instructions.
52
+
* Use Splunk's Puppet module to install and configure the package. A module is a collection of resources, classes, files, definition, and templates. To learn how to download and customize the module, see :ref:`deployment-linux-puppet`.
53
+
* Use Salt to deploy the Collector. For more information, see :ref:`deployments-linux-salt`.
54
+
55
+
.. note:: See also :ref:`otel_deployments`.
56
+
57
+
.. raw:: html
58
+
59
+
<embed>
60
+
<h2>Next steps<aname="install-linux-next"class="headerlink"href="#install-linux-next"title="Permalink to this headline">¶</a></h2>
Copy file name to clipboardExpand all lines: gdi/opentelemetry/collector-windows/deployments-windows-ansible.rst
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,3 +116,8 @@ The following table describes the variables that can be configured for this role
116
116
- The path to the Fluentd configuration file on the remote host. The default is ``%SYSTEMDRIVE%\opt\td-agent\etc\td-agent\td-agent.conf``.
117
117
* - ``splunk_fluentd_config_source``
118
118
- The source path to a Fluentd configuration file on your control host that is uploaded and set in place of the value set in ``splunk_fluentd_config`` on remote hosts. Use this variable to submit a custom Fluentd configuration, for example, ``./custom_fluentd_config.conf``. The default value is ``""``, which means that nothing is copied and the configuration file set with ``splunk_otel_collector_config`` is used.
0 commit comments