Reference Information for Collector Installation

These topics provide supporting information about Collector configuration parameters and options.

In this section, we will introduce the following concepts:

📄️ Test Connectivity for Sumo Logic Collectors

Make sure you have the required access and connectivity to the Sumo Logic service by running these checks from the machine where you want the Collector installed.

📄️ Download a Collector from a Static URL

Use our static URLs to download the most recent version of a Collector. The version of the Collector will be updated each time there is a release or patch.

📄️ Add a Collector to a Linux Machine Image

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

📄️ Add a Collector to a Windows Machine Image

Use the information in this topic to build a Sumo Logic Collector into a Windows machine image such as an Amazon AMI, a VMware image, or Azure virtual machine.

📄️ Set the Run As User for a Collector

By default, the Collector runs as the root user (Administrator on Windows). If you are using the command line installer to install a Collector, you can specify the-VrunAs.username=username] and -VwinRunAs.password=[password] parameters to change the Run As user. See [Parameters for the Command Line Installer for a full list of supported parameters.

📄️ Parameters for the Command Line Installer

The following tables provide and reference the available parameters for Collector installation using the command line installer. For details and example commands on Collector installation, see Install a Collector on Linux, Install a Collector on MacOS, and Install a Collector on Windows.

📄️ user.properties

For collector versions 19.137 and later, the user.properties file lets you pass configuration parameters during the installation of a new unregistered Collector. Once the collector is registered, to see if a parameter can be changed with a collector restart, check the "Can be changed after installation?" column of the table in user.properties parameters below. When using the shell script (command line) installer, you must pass configuration parameters via command-line arguments or a varfile, and the installer will create a user.properties file during installation (see Parameters for the Command Line Installer for more information).

📄️ Collector Installation Error Messages

For additional information, see Collector Management API.

📄️ Enhanced File System Security for Installed Collectors

The log cache and configuration files for an installed Collector can contain sensitive information. To address possible security issues associated with the cache and configuration files, Collector release 19.170 introduces an enhanced file system security mode for Collector installation.

📄️ Force a Collector's Name with Clobber

Each collector name must be unique. If you are installing a collector that would have the same name as an existing collector, the system automatically appends a 13-digit unix timestamp to the collector name. If you don't want to use the timestamp in a collector name, you can do either of the following:

📄️ Set a Collector as Ephemeral

During the installation process, if a Collector is flagged as ephemeral, the Collector will be deleted automatically after being offline for 12 hours. This can be helpful when using certain APIs, for example, where Amazon Machine Images (AMIs) are constantly created as new Collectors, but serve a purpose for only a short while. After being offline for a while, the AMI-created Collector is automatically deleted.