Deploy the Collector with Puppet for Windows đź”—
Use this module to install and configure the Collector on Windows. Download and install the module from Puppet Forge . After downloading the module, you can add customizations using the class
parameter.
On Windows systems, the puppetlabs/registry module is required to set the registry key/values, and the puppetlabs/powershell module is required to run Powershell commands.
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.
Use the Puppet module đź”—
To use this module, include the splunk_otel_collector
class in your manifests with the supported parameters (see Modify the class parameters for descriptions of the available parameters). For example, the following deployment definition is the simplest deployment definition with the default parameters (replace VERSION
with the desired Collector version, SPLUNK_ACCESS_TOKEN
with your Splunk access token to authenticate requests, and SPLUNK_REALM
for the realm to send the data to):
class { splunk_otel_collector:
collector_version => 'VERSION'
splunk_access_token => 'SPLUNK_ACCESS_TOKEN',
splunk_realm => 'SPLUNK_REALM',
}
Modify the class parameters đź”—
The class accepts the parameters described in the following table:
Name |
Description |
Default value |
---|---|---|
|
Version of the Collector package to install, for example, |
None |
|
Replaces |
90% of |
|
The Splunk access token to authenticate requests. This attribute is required. |
None |
|
Which realm to send the data to, for example, |
None |
|
Sets the Splunk ingest URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk API URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk trace endpoint URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk HEC endpoint URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk HEC authentication token if different than |
|
|
The path to the Smart Agent bundle directory. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the node. The |
|
|
The path to the collectd configuration directory for the Smart Agent bundle. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the node. The |
|
|
Total memory in MIB to allocate to the Collector; automatically calculates the ballast size. The |
|
|
|
None |
|
The source path to the Collector configuration YAML file. This file is copied to the |
|
|
Destination path of the Collector configuration file on the node. The |
|
|
Whether to install or manage Fluentd and dependencies for log collection. |
|
|
Source path to the Fluentd configuration file. This file is copied to the |
|
Next steps đź”—
After you have installed the package, see:
View logs and errors in the Windows Event Viewer. Search for “view logs and errors” on the Microsoft documentation site for more information.