Install the Collector for Windows using the MSI installer đź”—
You can use the Windows MSI installer to install the Splunk Distribution of the Collector for Windows.
Note
The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in Collector for Windows default configuration. To modify this configuration, refer to Advanced configuration for Windows.
To learn how to obtain logs, see Collect logs with the Collector for Windows.
Alternatively, you can also install the Collector for Windows:
Using the installer script. See Install the Collector for Windows with the installer script.
Using deployment tools. See Install the Collector for Windows using deployment tools.
Manually. See Install the Collector for Windows manually.
Prerequisites đź”—
The Collector supports the following Windows versions, depending on the installation method:
Install method |
Supported versions (64-bit) |
---|---|
Installer script |
Windows 10 Pro and Home, Windows Server 2016, 2019, 2022, 2025 |
Windows installer (MSI) |
Windows 10 Pro and Home, Windows Server 2016, 2019, 2022, 2025 |
Ansible |
Windows 10 Pro and Home, Windows Server 2016, 2019, 2022, 2025 |
Chef |
Windows 10 Pro and Home, Windows Server 2019, 2022 |
Nomad |
Windows 10 Pro and Home, Windows Server 2016, 2019 |
Puppet |
Windows 10 Pro and Home, Windows Server 2016, 2019 |
Docker |
Windows 10 Pro and Home, Windows Server 2019, 2022 |
Note
PowerShell 3.0 or higher is required.
Install the Collector using the Windows installer file (MSI) đź”—
To install the package using Windows Installer, download the Windows MSI package (64-bit only) from the Collector’s GitHub release site .
The package is installed to
\Program Files\Splunk\OpenTelemetry Collector
.The
splunk-otel-collector
service is created, but not started.A default configuration file is copied to
\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml
, if it does not already exist. This file is required to start thesplunk-otel-collector
service.
Note
The ProgramData
folder is hidden by default on Windows.
Next, follow the installer steps, or install the Collector using a PowerShell terminal.
Install using the graphical installer đź”—
Run the downloaded package and follow the instructions in the guided setup.
Install using a PowerShell terminal đź”—
Follow these steps:
Open a PowerShell terminal.
Run the following command, where
PATH_TO_MSI
is the full path to the downloaded package. For example,C:\your\download\folder\splunk-otel-collector-0.4.0-amd64.msi
.Start-Process -Wait msiexec "/i PATH_TO_MSI /qn"
Configure the Collector using the variables listed in the table that follows:
Start-Process -Wait msiexec "/i PATH_TO_MSI /qn SPLUNK_ACCESS_TOKEN=<my_access_token>"
Use the following installation configurations with the MSI deployment method:
Name |
Description |
Default |
---|---|---|
|
The Splunk access token to authenticate requests. |
Empty |
|
The Splunk API URL. |
|
|
The path to the Smart Agent bundle. |
|
|
The path to the collectd config directory for the Smart Agent. For example, |
Optional. Only added if passed to msiexec command. |
|
Destination path of the Collector custom configuration file. |
|
|
URL in Gateway mode. |
Optional. Only added if passed to msiexec command. |
|
The Splunk HEC authentication token. |
|
|
The Splunk HEC endpoint URL. |
|
|
The Splunk ingest URL. |
|
|
The network interface the agent receivers listen on. |
Optional. Only added if passed to msiexec command. |
|
Use it to set the memory limit for the |
Optional. Only added if passed to msiexec command. |
|
Total memory in MiB to allocate to the Collector |
Optional. Only added if passed to msiexec command. |
|
Your Splunk realm. |
|
|
Install property that sets the Collector’s deployment mode to either |
|
|
The Splunk trace endpoint URL. |
|
Start the
splunk-otel-collector
service by rebooting the system or by running the following command in a PowerShell terminal:
Start-Service splunk-otel-collector
Learn more about advanced configuration options (including Service Logging) using PowerShell in the following docs:
Custom MSI URLs đź”—
By default, the Collector MSI is downloaded from https://dl.signalfx.com .
To specify custom URLs for these downloads, replace COLLECTOR_MSI_URL
with the URL to the desired MSI packages to install:
& {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; collector_msi_url = "<COLLECTOR_MSI_URL>"; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
Install the Collector using a Chocolatey package đź”—
A Chocolatey package is available to download, install, and configure the Collector with the following PowerShell command:
choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"
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.