Ansible for Windows 🔗
Before installing the Ansible collection, do the following:
Find your Splunk access token
Find your Splunk realm
Check exposed ports to make sure your environment doesn’t have conflicts. Ports can be changed in the package’s configuration.
Ansible requires PowerShell 3.0 or newer and at least .NET 4.0 to be installed on the Windows host. A WinRM listener should be created and activated. You can find information on setting up the Windows host on the Ansible Documentation site .
Run the following command to install the Ansible collection from Ansible Galaxy:
ansible-galaxy collection install signalfx.splunk_otel_collector
To use this role, include the signalfx.splunk_otel_collector.collector role
invocation in your playbook. Note that this role requires root access. The following example shows how to use the role in a playbook with minimal required configuration:
- name: Install the Splunk Distribution of OpenTelemetry Collector
hosts: all
become: yes
# Setting the "become: yes" tag generates the following error message:
# "The Powershell family is incompatible with the sudo become plugin".
# Remove the "become: yes" tag.
tasks:
- name: "Include splunk_otel_collector"
include_role:
name: "signalfx.splunk_otel_collector.collector"
vars:
splunk_access_token: YOUR_ACCESS_TOKEN
splunk_realm: SPLUNK_REALM
The following table describes the variables that can be configured for this role:
Variable |
Description |
---|---|
|
The Splunk access token to authenticate requests. This attribute is required. |
|
The realm to send the data to. This variable is set with this value for the service. The default value is |
|
The Splunk ingest URL, for example, |
|
The Splunk API URL, for example, |
|
The Splunk trace endpoint URL, for example, |
|
The Splunk HEC endpoint URL, for example, |
|
The version of the package to install, for example, |
|
The configuration file, created in YAML. This variable can be set to |
|
The custom configuration that is merged into the default configuration. |
|
The variable used to configure the |
|
This is the source path to a configuration file on your control host that is uploaded and set in place of the value set in |
|
The path to the bundle directory. The default path is provided by the package. If the specified path is changed from the default value, the path should be an existing directory on the node. This variable is set with this value for the service. The default location is |
|
The path to the collectd configuration directory for the bundle. The default path is provided by the package. If the specified path is changed from the default value, the path should be an existing directory on the node. This variable is set with this value for the service. The default location is |
|
The amount of allocated memory in MiB. The default value is |
|
The set memory ballast size in MiB. The default value is 1/3 of the value set in |
|
The option to install or manage Fluentd and dependencies for log collection. The default value is |
|
The version of td-agent (Fluentd package) that is installed. |
|
The path to the Fluentd configuration file on the remote host. The default is |
|
The source path to a Fluentd configuration file on your control host that is uploaded and set in place of the value set in |