Docs » Get started with the Splunk Distribution of the OpenTelemetry Collector » Collector deployment tools and options » Deploy the Collector with Puppet for Windows

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

collector_version

Version of the Collector package to install, for example, 0.25.0. The version must correspond to Github Releases without the preceding v. This attribute is required.

None

gomemlimit

Replaces splunk_ballast_size_mib starting in Collector version 0.97.0. It allows limiting memory usage in the GO runtime, helping enhance garbage collection and prevent out of memory situations. Learn more at how to update memory ballast in your configuration.

90% of splunk_total_mem_mib

splunk_access_token

The Splunk access token to authenticate requests. This attribute is required.

None

splunk_realm

Which realm to send the data to, for example, us0. The Splunk ingest and API URLs are inferred by this value. The SPLUNK_REALM environment variable is set with this value for the collector service. This attribute is required. To find your Splunk realm, see Note about realms.

None

splunk_ingest_url

Sets the Splunk ingest URL explicitly instead of the URL inferred by the $splunk_realm parameter. The SPLUNK_INGEST_URL environment variable is set with this value for the Collector service.

https://ingest.${splunk_realm}.signalfx.com

splunk_api_url

Sets the Splunk API URL explicitly instead of the URL inferred by the $splunk_realm parameter. The SPLUNK_API_URL environment variable is set with this value for the Collector service.

https://api.${splunk_realm}.signalfx.com

splunk_trace_url

Sets the Splunk trace endpoint URL explicitly instead of the URL inferred by the $splunk_ingest_url parameter. The SPLUNK_TRACE_URL environment variable is set with this value for the Collector service.

${splunk_ingest_url}/v2/trace

splunk_hec_url

Sets the Splunk HEC endpoint URL explicitly instead of the URL inferred by the $splunk_ingest_url parameter. The SPLUNK_HEC_URL environment variable is set with this value for the Collector service.

${splunk_ingest_url}/v1/log

splunk_hec_token

Sets the Splunk HEC authentication token if different than $splunk_access_token. The SPLUNK_HEC_TOKEN environment variable is set with this value for the Collector service.

$splunk_access_token

splunk_bundle_dir

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 SPLUNK_BUNDLE_DIR environment variable is set to this value for the Collector service.

%PROGRAMFILES%\Splunk\OpenTelemetry Collector\agent-bundle

splunk_collectd_dir

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 SPLUNK_COLLECTD_DIR environment variable is set to this value for the Collector service.

${splunk_bundle_dir}\run\collectd

splunk_memory_total_mib

Total memory in MIB to allocate to the Collector; automatically calculates the ballast size. The SPLUNK_MEMORY_TOTAL_MIB environment variable is set to this value for the Collector service.

512

splunk_ballast_size_mib

splunk_ballast_size_mib is deprecated starting on Collector version 0.97.0. If you’re using it, see how to update your configuration.

None

collector_config_source

The source path to the Collector configuration YAML file. This file is copied to the $collector_config_dest path on the node. See the source attribute of the file resource for the supported value types. The default source file is provided by the Collector package.

%PROGRAMFILES\Splunk\OpenTelemetry Collector\agent_config.yaml

collector_config_dest

Destination path of the Collector configuration file on the node. The SPLUNK_CONFIG environment variable is set with this value for the Collector service.

%PROGRAMDATA%\Splunk\OpenTelemetry Collector\agent_config.yaml

with_fluentd

Whether to install or manage Fluentd and dependencies for log collection.

false

fluentd_config_source

Source path to the Fluentd configuration file. This file is copied to the $fluentd_config_dest path on the node. See the source attribute of the file resource for the supported value types. The default source file is provided by the Collector package. Only applicable if $with_fluentd is set to true.

%PROGRAMFILES\Splunk\OpenTelemetry Collector\fluentd\td-agent.conf