---
id: windows
title: Install OpenTelemetry Collector on Windows
sidebar_label: Windows
description: Install the OpenTelemetry Collector on Windows to collect metrics and logs for end-to-end observability in Sumo Logic environments.
slug: /help/docs/send-data/opentelemetry-collector/install-collector/windows/
canonical: https://www.sumologic.com/help/docs/send-data/opentelemetry-collector/install-collector/windows/
---
import useBaseUrl from '@docusaurus/useBaseUrl';
})
Follow the steps in this topic to install or uninstall an OpenTelemetry Collector on Windows. See [OpenTelemetry Collector](/docs/send-data/opentelemetry-collector) for information on other operating systems.
## System Requirements
Minimal resource requirements are the following:
* 200 MB of disk space
* 64 MB of RAM
Supported Versions
* Windows 10 and up, Windows Server 2016 and up
## Install
You can install our OpenTelemetry Collector using either of the following methods:
* [UI Installation](#ui-installation)
* [Install script](#install-script)
* [Manual step-by-step installation](#manual-step-by-step-installation)
### UI Installation
1. [**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic main menu, select **Data Management**, and then under **Data Collection** select **OpenTelemetry Collection**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collection**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**.
1. On the OpenTelemetry Collection page, click **Add Collector**.
1. On the left panel, select **Windows** as the platform.
})
1. Select/create an installation token and customize your tags.
1. Select the **Time Zone**. By default, the timezone is set to `(UTC) Etc/UTC`.
1. (Optional) In the **Collector Settings**, select the **Ephemeral** checkbox to auto-delete your collector after 12 hours and select the **Locally Manage Collector** checkbox if you want to configure, maintain, and monitor the collector locally.
1. Copy the command.
1. Open PowerShell and execute the command in the PowerShell where the collector needs to be installed.
})
1. Wait for the installation process to complete, then click **Next** to proceed.
1. On the next screen, you will see a list of available Source Templates. Select the required Source Template and proceed with the data configuration.
If you choose to close this Source template creation screen, you can navigate back. [**New UI**](/docs/get-started/sumo-logic-ui/). In the Sumo Logic main menu select **Data Management**, and then under **Data Collection** select **Source Template**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.
### Install Script
A single-line installation powered by Install Script.
#### Get the Installation Token
Get your [installation token](/docs/manage/security/installation-tokens) if you do not already have it. We will refer to this token as `` in the next steps.
#### Run Installation Script
Run the following command in the same PowerShell window, replacing `` with your token from the previous step:
```sh
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; $uri = "https://download-otel.sumologic.com/latest/download/install.ps1"; $path="${env:TEMP}\install.ps1"; (New-Object System.Net.WebClient).DownloadFile($uri, $path); . $path -InstallationToken "" -Tags @{"host.group" = "default"; "deployment.environment" = "default"}
```
The script is going to perform the following operations:
* Install or upgrade the operation by placing the latest version in `C:\Program Files\Sumo Logic\OpenTelemetry Collector\bin`.
* Get [static configuration](https://github.com/SumoLogic/sumologic-otel-collector/blob/main/examples/sumologic.yaml) and place it as `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\sumologic.yaml`
* Create user configuration directory (`C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d`) with `common.yaml` file, which will contain installation token
* Create `OtelcolSumo` (`Sumo Logic OpenTelemetry Collector`) service
#### Script Options
| Name | Description | Takes Value |
|:--|:--|:--|
| `-InstallationToken` | Installation token | Yes |
| `-Tags` | Sets tags for the collector. This argument should be a map. | Yes, for example `@{"host.group" = "default"; "deployment.environment" = "default"}` |
| `-InstallHostMetrics` | Installs the hostmetrics configuration to collect host metrics. The default is `$False`. | Yes, for example: `-InstallHostMetrics $True` or `-InstallHostMetrics $False`. |
| `-Fips` | If set to `$True`, installs the FIPS-compliant binary. The default is `$False`. See [FIPS](#fips) section for more details. | Yes, for example: `-Fips $True` or `-Fips $False` |
| `-Version` | Version of Sumo Logic Distribution for OpenTelemetry Collector to install. By default, it gets the latest version. | Yes, for example: `-Version 0.94.0-sumo-2` |
### Manual Step-by-Step Installation
1. Go to the [latest release documentation](https://github.com/SumoLogic/sumologic-otel-collector-packaging/releases/latest).
2. Download `otelcol-sumo_x.y.z.0_en-US.x64.msi` from the `Assets` section.
})
3. Run Installer.
})
4. Read and accept End-User License Agreement.
})
5. Select binary destination.
})
6. Set Installation Token and Tags properties.
})
7. Click **Install** to begin installation.
})
8. Wait for the installation to be completed.
})
9. You can modify the configuration, which should be placed in the `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config` directory.
:::note
`C:\ProgramData` directory is hidden by default.
:::
### Verify the Installation
Run the following command in PowerShell:
```sh
> Get-Service OtelcolSumo
Status Name DisplayName
------ ---- -----------
Running OtelcolSumo Sumo Logic OpenTelemetry Collector
```
Alternatively, you can open `Services.msc` and check whether the Sumo Logic OTel Collector Service is running or not.
### Additional Settings
This section describes common OpenTelemetry customizations.
#### Using Proxy
Exporters leverage the HTTP communication and respect the following proxy environment variables:
* `HTTP_PROXY`
* `HTTPS_PROXY`
* `NO_PROXY`
You can set it by adding the following properties to the Windows Registry key `HKLM:\SYSTEM\CurrentControlSet\Services\OtelcolSumo\Environment`:
```text
FTP_PROXY=:
HTTP_PROXY=:
HTTPS_PROXY=:
```
You can do it using the following PowerShell command:
```powershell
Set-ItemProperty `
-Path 'HKLM:\SYSTEM\CurrentControlSet\Services\OtelcolSumo' `
-Name Environment `
-Type MultiString `
-Value "FTP_PROXY=:",
"HTTP_PROXY=:",
"HTTPS_PROXY=:"
```
To exclude a specific domain or IP address from using the proxy, you can add it to the `NO_PROXY` environment variable. For example, to exclude the domain `sumologic.com` from using the proxy, you can add the following line:
```text
NO_PROXY=sumologic.com
```
:::info
Restart `Sumo Logic OpenTelemetry Collector` (`OtelcolSumo`) service to apply the changes.
:::
:::note
For running multiple collectors on the same host, you must configure each collector to use a unique credentials directory. To do this, set the `collector_credentials_directory` field in the Sumo Logic extension configuration to a different directory for each collector. This ensures that collectors do not share the same credentials. For more details, refer to the [Sumo Logic extension documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.137.0/extension/sumologicextension).
:::
#### FIPS
To install FIPS compliant binary, add `-Fips $True` option to the installation command.
Refer to [BoringCrypto and FIPS compliance](https://github.com/SumoLogic/sumologic-otel-collector/blob/main/docs/fips.md) in our repository for more details.
## Uninstalling the collector
The uninstall process depends on how the collector was originally installed.
### Using the install script
If the Collector was installed using the install script, run the following command to uninstall it:
```bash
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; $uri = "https://download-otel.sumologic.com/latest/download/install.ps1"; $path="${env:TEMP}\install.ps1"; (New-Object System.Net.WebClient).DownloadFile($uri, $path); . $path -Uninstall
```
To also remove all existing configurations, add the `-Purge` flag:
```bash
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; $uri = "https://download-otel.sumologic.com/latest/download/install.ps1"; $path="${env:TEMP}\install.ps1"; (New-Object System.Net.WebClient).DownloadFile($uri, $path); . $path -Uninstall -Purge
```
### Manual uninstall
1. Go to **Add or remove programs**.
})
1. Find **OpenTelemetry Collector** and click **Uninstall**.
})
1. Confirm the uninstallation.
})
## Upgrading the Collector
The upgrade process depends on how the collector was originally installed.
### Using the install script
Run the following script to automatically upgrade the Collector to the latest version:
```bash
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; $uri = "https://download-otel.sumologic.com/latest/download/install.ps1"; $path="${env:TEMP}\install.ps1"; (New-Object System.Net.WebClient).DownloadFile($uri, $path); . $path -Upgrade
```
### Manual upgrade
If the Collector was installed manually, upgrade it by completing the following steps:
1. [Uninstall the Collector manually](#manual-uninstall).
1. [Reinstall the Collector with a new version](#manual-step-by-step-installation). Reinstalling will upgrade the binary in place.
## Update your Config
After upgrading, verify that your OpenTelemetry Collector configuration is up to date.
- To see changes in upstream OpenTelemetry components, refer to the [core changelog](https://github.com/open-telemetry/opentelemetry-collector/releases) and [contrib changelog](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases).
- For breaking changes specific to the Sumo Logic Distribution of OpenTelemetry Collector, see the [upgrade guide](https://github.com/SumoLogic/sumologic-otel-collector/blob/main/docs/upgrading.md).
## Troubleshooting
### Cannot restart service during Installation
If you get the following output while restarting the service:
```shell
> Restart-Service -Name OtelcolSumo
Restart-Service : Service 'Sumo Logic OpenTelemetry Collector (OtelcolSumo)' cannot be stopped due to the following
error: Cannot open OtelcolSumo service on computer '.'.
At line:1 char:1
+ Restart-Service -Name OtelcolSumo
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : CloseError: (System.ServiceProcess.ServiceController:ServiceController) [Restart-Service
], ServiceCommandException
+ FullyQualifiedErrorId : CouldNotStopService,Microsoft.PowerShell.Commands.RestartServiceCommand
```
Ensure that you run **PowerShell** as an Administrator.
For information on troubleshooting and solutions, refer to the [Troubleshooting](/docs/send-data/opentelemetry-collector/troubleshooting).
### Error when running the FIPS binary: `panic: cngcrypto: not in FIPS mode`
If you installed the FIPS version of the OpenTelemetry Collector and are getting the following error when trying to run it:
```console
C:\>"C:\Program Files\Sumo Logic\OpenTelemetry Collector\bin\otelcol-sumo.exe" --version
panic: cngcrypto: not in FIPS mode
goroutine 1 [running]:
crypto/internal/backend.init.0()
crypto/internal/backend/cng_windows.go:34 +0x85
```
This means you are running the Sumo Logic Otelcol FIPS binary in a non-FIPS environment. The FIPS binary is built in `requirefips` mode, which means the collector only works in a FIPS-compliant environment and will fail to start otherwise.
To verify if your instance is in FIPS mode, open your registry editor and navigate to **HKLM\System\CurrentControlSet\Control\Lsa\FIPSAlgorithmPolicy\Enabled**.
* If the Enabled value is `1`, then FIPS is enabled successfully.
* If the Enabled value is `0`, this means FIPS is not enabled. See the [Build option to require FIPS mode](https://github.com/microsoft/go/blob/microsoft/main/eng/doc/fips/README.md#build-option-to-require-fips-mode) documentation to enable it.