Install a Collector on Windows

Follow the steps in this topic to install or uninstall a collector on Windows. See Installed Collectors for information on other OSs.

System Requirements

• Windows 7, 32 or 64 bit
• Windows 8, 32 or 64 bit
• Windows 8.1, 32 or 64 bit
• Windows 10, 32 or 64 bit
• Windows 11, 32 or 64 bit
• Windows Server 2012
• Windows Server 2016
• Windows Server 2019
• Windows Server 2022
• Single core, 512MB RAM
• 8GB disk space
• Package installers require TLS 1.2 or higher.

Download

Download the Collector in either of the following ways.

Via installation

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
   New UI. In the top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
2. Click Add Collector.
3. Click Installed Collector.
4. Click the link for the Collector to begin the download.

Via browser

Open a browser and enter the static URL for your Sumo deployment. See Which endpoint should I use? if you are unsure. The download begins immediately. See Download a Collector from a Static URL for a list of URLs for your deployment pod.

Install Collector

Install the Collector using either the UI installer or command-line installer.

You can build a Collector into a Windows machine image such as an Amazon AMI or VMware image.

After installing Collectors, you can configure Sources directly in Sumo Logic or by providing the Source settings in a JSON file. If you're using a UTF-8 encoded JSON file, you must provide the file before starting the Collector. The JSON file needs to be UTF-8 encoded.

If necessary, you can use the binary package to install a Collector on MacOS. See this Collector FAQ topic for details.

Using the UI installer

note

This method does not support all advanced settings.

Run the installer on your server with root or Administrator privileges. For Windows, right-click the installer file and select Run as Administrator. If you're not logged in as root or Administrator, you may be prompted to reauthenticate when you start the UI Installer.

1. Open the downloaded installer file.
2. If prompted, enter the root or Administrator user name and password for the system.
3. Open the wizard to show the Welcome page. Click Next.
4. Accept the license agreement and click Next.
5. Browse to select a location for the Collector or accept the default and click Next to install the Collector files on your machine.
6. The Installer displays the summary of the default settings. If you want to change any of these, click Advanced UI Installer Settings and follow the instructions. Click Next.
7. Choose an authentication method.
   • Access Key. If you have a Sumo Logic access ID and key, click Next, enter the access ID and key, and click Next.
   • Installation Token. Enter the Token String you want to use to register the Collector in the input box.
8. Click Finish to complete the setup.
9. In Sumo Logic, select Manage Data > Collection > Collection and verify that you can see the Collector. Look for the name that is listed as Collector Name in the confirmation step of this procedure (the name can be customized under Advanced Settings). If a Collector with that name already exists, a suffix is appended to uniquely identify it. If you don’t see the Collector, check the Error Codes list to help troubleshoot.

Using the command line installer

1. From the command prompt, run the downloaded EXE file with with the parameters that you want to configure. See Parameters for the Command Line Installer for a description of the parameters.
2. When you see the Finishing installation... message you can close the command prompt window. The installation is complete.

The -console parameter is required to display output messages from the installation.

PowerShell users

When using quiet mode installation on Windows with Microsoft PowerShell, parameters following -console -q must be escaped with quotes, for example:

SumoCollector.exe -console -q "-Vsumo.accessid=<accessId>" "-Vsumo.accesskey=<accessKey>" "-Vsources=<filepath>"

Or, if you're using -varfile:

Start-Process C:\<path to collector executable>\SumoCollector.exe -Wait -ArgumentList "-q","-console","-varfile `"C:\<path to varfile>\sumo_credentials.txt`""

Examples

Using an Installation Token:

SumoCollector.exe -console -q "-Vsumo.token_and_url=<installationToken>" "-Vsources=<filepath>"

Using access ID and access key:

SumoCollector.exe -console -q "-Vsumo.accessid=<accessId>" "-Vsumo.accesskey=<accessKey>" "-Vsources=<filepath>"

Using access ID and access key with proxy settings:

SumoCollector.exe -console -q "-Vsumo.accessid=<accessId>" "-Vsumo.accesskey=<accessKey>" "-Vsources=<filepath>" "-Vproxy.host=<proxyHost>" "-Vproxy.port=<proxyPort>"

Uninstall

If you uninstall a Collector, no more data is sent to Sumo Logic from that machine. Uninstalling a Collector doesn't cancel your Sumo Logic account or delete any data from Sumo Logic.

Uninstalling a Sumo Logic installed Collector requires the following steps:

1. Uninstall the Collector from the host machine using either of these methods.
   • Uninstall using the installer
   • Uninstall from the command line
2. Remove the Collector from Sumo Logic.

Uninstall using the installer

1. From the Windows Control Panel choose Uninstall a program.
2. Right-click Sumo Logic Collector and choose Uninstall.
3. Click Next to uninstall the Collector.
4. When the success message is displayed, click Finish.

Uninstall from the command line

1. From the command prompt, run the uninstall.exe file with the -q option. The -q option executes the command without presenting additional prompts.

   uninstall.exe -q -console
   note

   On Windows, the -console parameter is required to display output messages.

2. When you see the Finishing installation... message you can close the command prompt window. The uninstallation is complete.

Remove the Collector from Sumo Logic

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
   New UI. In the top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
2. Find the Collector you want to remove, and click Delete.
3. When the Confirm dialog displays, click OK.

A success message is displayed and the Collector is removed from the list.