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.
* View logs and errors in the Windows Event Viewer. Search for "view logs and errors" on the :new-page:`Microsoft documentation site <https://docs.microsoft.com/en-us/>` for more information.
:description: Describes how to install the Splunk Distribution of OpenTelemetry Collector for Windows manually.
8
+
:description: Describes how to install the Splunk Distribution of the OpenTelemetry Collector for Windows manually.
9
9
10
10
.. toctree::
11
11
:maxdepth:4
12
12
:titlesonly:
13
13
:hidden:
14
14
15
-
Before proceeding to install the Collector for Windows manually, check the :ref:`prerequisites <windows-otel-requirements>`.
15
+
You can use Windows MSI to install the Splunk Distribution of the Collector for Windows.
16
16
17
-
.. _windows-manual-config-var:
18
-
19
-
Modify the default configuration
20
-
==========================================
21
-
22
-
All installation methods offer default configurations using environment variables. Before starting the ``splunk-otel-collector`` service, replace the variables in the default configuration file with the appropriate values for your environment. See :ref:`otel-windows-config` for more information.
23
-
24
-
.. include:: /_includes/collector-env-vars.rst
25
-
26
-
.. note:: When configuring additional settings, use service, process, or terminal scopes.
27
-
28
-
Configure proxy settings
29
-
----------------------------------
30
-
31
-
To configure proxy settings to install and run the OpenTelemetry Collector, see :ref:`configure-proxy-collector`.
To install the package using Windows Installer, download the Windows MSI package (64-bit only) from :new-page:`GitHub releases <https://github.com/signalfx/splunk-otel-collector/releases>`.
39
-
40
-
- The package is installed to ``\Program Files\Splunk\OpenTelemetry Collector``.
41
-
- The ``splunk-otel-collector`` service is created, but not started.
42
-
- 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 the ``splunk-otel-collector`` service.
43
-
44
-
.. note:: The ``ProgramData`` folder is hidden by default on Windows.
45
-
46
-
Next, proceed with the GUI, or follow the instructions to install using a Powershell terminal.
47
-
48
-
.. _windows-manual-installer-gui:
49
-
50
-
Install using the GUI
51
-
---------------------------------
52
-
53
-
Run the downloaded package and follow the instructions in the guided setup.
54
-
55
-
.. _windows-powershell:
56
-
57
-
Install using a PowerShell terminal
58
-
-----------------------------------------------
59
-
60
-
Follow these steps:
61
-
62
-
1. Open a PowerShell terminal.
63
-
2. 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``.
64
-
65
-
.. code-block:: PowerShell
66
-
67
-
Start-Process-Wait msiexec "/i PATH_TO_MSI /qn"
68
-
69
-
3. Update :ref:`all variables in the configuration file <windows-manual-config-var>` as appropriate.
70
-
4. Start the ``splunk-otel-collector`` service by rebooting the system or by running the following command in a PowerShell terminal:
71
-
72
-
.. code-block:: PowerShell
73
-
74
-
Start-Service splunk-otel-collector
75
-
76
-
Learn more about advanced configuration options (including Service Logging) using PowerShell in the Splunk Distribution of OpenTelemetry Collector :new-page:`Windows manual <https://github.com/signalfx/splunk-otel-collector/blob/main/docs/getting-started/windows-manual.md>`.
Install, configure, and start the Collector with :ref:`Windows Installer <windows-installer>`. The Collector default configuration file ``\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml`` listens for log events on ``127.0.0.1:8006`` and sends them to Splunk Observability Cloud.
87
-
88
-
Log collection with Fluentd
89
-
-----------------------------------------------
90
-
91
-
.. note:: You need to be an Admin to configure log collection with Fluentd.
92
-
93
-
Perform the following steps to install Fluentd and forward ``collected`` log events to the Collector:
94
-
95
-
1. Install :new-page:`Fluentd MSI <https://docs.fluentd.org/installation/install-by-msi#td-agent-v4>` version 4.0 or higher.
96
-
97
-
2. Configure Fluentd to collect log events and forward them to the Collector:
98
-
99
-
- Option 1: Update the default config file provided by the Fluentd MSI at ``\opt\td-agent\etc\td-agent\td-agent.conf`` to collect the desired log events and forward them to ``127.0.0.1:8006``.
100
-
101
-
- Option 2: The installed Collector package provides a custom Fluentd config file ``\Program Files\Splunk\OpenTelemetry Collector\fluentd\td-agent.conf`` to collect log events from the Windows Event Log ``\Program Files\Splunk\OpenTelemetry Collector\fluentd\conf.d\eventlog.conf`` and forwards them to ``127.0.0.1:8006``.
17
+
.. note::
102
18
103
-
To use these files, backup the ``\opt\td-agent\etc\td-agent``` directory, and copy the contents from ``\Program Files\Splunk\OpenTelemetry Collector\fluentd``` to ``\opt\td-agent\etc\td-agent```.
19
+
The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. To modify this configuration, refer to :ref:`otel-windows-config`.
104
20
105
-
3. To apply any changes made to the Fluentd config files, restart the system, or restart ``fluentdwinsvc`` .
21
+
To learn how to obtain logs, see :ref:`windows-config-logs`.
106
22
107
-
.. code-block:: PowerShell
23
+
Alternatively, you can also install the Collector for Windows:
108
24
109
-
-Stop-Service fluentdwinsvc
110
-
-Start-Service fluentdwinsvc
25
+
* Using the installer script. See :ref:`otel-install-windows`.
26
+
* Using MSI. See :ref:`otel-install-windows-msi`.
27
+
* Using deployment tools. See :ref:`otel-install-windows-tools`.
111
28
112
-
4. View the Fluentd service logs and errors in ``\opt\td-agent\td-agent.log``.
29
+
.. _install-windows-manual-prereqs:
113
30
114
-
Learn more about general Fluentd configuration details in the :new-page:`official Fluentd documentation <https://docs.fluentd.org/configuration>`.
115
-
116
-
.. _windows-chocolatey:
117
-
118
-
Install using a Chocolatey package
119
-
===========================================
31
+
Prerequisites
32
+
==========================
120
33
121
-
A :new-page:`Chocolatey package <https://community.chocolatey.org/packages/splunk-otel-collector>` is available to download, install, and configure the Collector and Fluentd with the following PowerShell command:
Learn more about the :new-page:`package parameters <https://github.com/signalfx/splunk-otel-collector/blob/main/docs/getting-started/windows-manual.md#package-parameters>` in GitHub.
To install the Collector using the binary file, follow these steps:
149
56
@@ -212,10 +119,4 @@ Example with ``--config``
212
119
Next steps
213
120
==================================
214
121
215
-
After you have installed the package, see:
216
-
217
-
* :ref:`windows-config-ootb`.
218
-
* :ref:`otel-windows-config`.
219
-
* :ref:`collector-how-to`.
220
-
* :ref:`use-navigators-imm`.
221
-
* View logs and errors in the Windows Event Viewer. Search for "view logs and errors" on :new-page:`Microsoft documentation site <https://docs.microsoft.com/en-us/>` for more information.
:description: Describes how to install the Splunk Distribution of the OpenTelemetry Collector for Windows using the MSI installer.
9
+
10
+
.. toctree::
11
+
:maxdepth:4
12
+
:titlesonly:
13
+
:hidden:
14
+
15
+
You can use the Windows MSI installer to install the Splunk Distribution of the Collector for Windows.
16
+
17
+
.. note::
18
+
19
+
The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in :ref:`windows-config-ootb`. To modify this configuration, refer to :ref:`otel-windows-config`.
20
+
21
+
To learn how to obtain logs, see :ref:`windows-config-logs`.
22
+
23
+
Alternatively, you can also install the Collector for Windows:
24
+
25
+
* Using the installer script. See :ref:`otel-install-windows`.
26
+
* Using deployment tools. See :ref:`otel-install-windows-tools`.
27
+
* Manually. See :ref:`otel-install-windows-manual`.
To install the package using Windows Installer, download the Windows MSI package (64-bit only) from the Collector's :new-page:`GitHub release site <https://github.com/signalfx/splunk-otel-collector/releases>`.
42
+
43
+
- The package is installed to ``\Program Files\Splunk\OpenTelemetry Collector``.
44
+
- The ``splunk-otel-collector`` service is created, but not started.
45
+
- 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 the ``splunk-otel-collector`` service.
46
+
47
+
.. note:: The ``ProgramData`` folder is hidden by default on Windows.
48
+
49
+
Next, follow the installer steps, or install the Collector using a PowerShell terminal.
50
+
51
+
.. _windows-manual-installer-gui:
52
+
53
+
Install using the graphical installer
54
+
--------------------------------------
55
+
56
+
Run the downloaded package and follow the instructions in the guided setup.
57
+
58
+
.. _windows-powershell:
59
+
60
+
Install using a PowerShell terminal
61
+
-----------------------------------------------
62
+
63
+
Follow these steps:
64
+
65
+
1. Open a PowerShell terminal.
66
+
2. 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``.
67
+
68
+
.. code-block:: PowerShell
69
+
70
+
Start-Process-Wait msiexec "/i PATH_TO_MSI /qn"
71
+
72
+
1. Update all variables in the configuration file as appropriate. See :ref:`windows-config-change-default` for more information.
73
+
2. Start the ``splunk-otel-collector`` service by rebooting the system or by running the following command in a PowerShell terminal:
74
+
75
+
.. code-block:: PowerShell
76
+
77
+
Start-Service splunk-otel-collector
78
+
79
+
Learn more about advanced configuration options (including Service Logging) using PowerShell in the following docs:
If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance.
90
+
91
+
.. note:: You need to be an Admin to configure log collection with Fluentd.
92
+
93
+
Perform the following steps to install Fluentd and forward ``collected`` log events to the Collector:
94
+
95
+
1. Install :new-page:`Fluentd MSI <https://docs.fluentd.org/installation/install-by-msi#td-agent-v4>` version 4.0 or higher.
96
+
97
+
2. Configure Fluentd to collect log events and forward them to the Collector:
98
+
99
+
- Option 1: Update the default config file provided by the Fluentd MSI at ``\opt\td-agent\etc\td-agent\td-agent.conf`` to collect the desired log events and forward them to ``127.0.0.1:8006``.
100
+
101
+
- Option 2: The installed Collector package provides a custom Fluentd config file ``\Program Files\Splunk\OpenTelemetry Collector\fluentd\td-agent.conf`` to collect log events from the Windows Event Log ``\Program Files\Splunk\OpenTelemetry Collector\fluentd\conf.d\eventlog.conf`` and forwards them to ``127.0.0.1:8006``.
102
+
103
+
To use these files, backup the ``\opt\td-agent\etc\td-agent``` directory, and copy the contents from ``\Program Files\Splunk\OpenTelemetry Collector\fluentd``` to ``\opt\td-agent\etc\td-agent```.
104
+
105
+
3. To apply any changes made to the Fluentd config files, restart the system, or restart ``fluentdwinsvc`` .
106
+
107
+
.. code-block:: PowerShell
108
+
109
+
-Stop-Service fluentdwinsvc
110
+
-Start-Service fluentdwinsvc
111
+
112
+
4. View the Fluentd service logs and errors in ``\opt\td-agent\td-agent.log``.
113
+
114
+
Learn more about general Fluentd configuration details in the :new-page:`official Fluentd documentation <https://docs.fluentd.org/configuration>`.
By default, the Collector MSI is downloaded from :new-page:`https://dl.signalfx.com <https://dl.signalfx.com>` and
120
+
the Fluentd MSI is downloaded from :new-page:`https://packages.treasuredata.com <https://packages.treasuredata.com>`.
121
+
122
+
To specify custom URLs for these downloads, replace ``COLLECTOR_MSI_URL`` and ``FLUENTD_MSI_URL`` with the URLs to the desired MSI packages to install:
A :new-page:`Chocolatey package <https://community.chocolatey.org/packages/splunk-otel-collector>` is available to download, install, and configure the Collector and Fluentd with the following PowerShell command:
0 commit comments