Skip to main content
Sumo Logic

user.properties

For Collector versions 19.137 and higher, the user.properties file lets you pass Collector configuration parameters to Sumo Logic during installation, if the Collector is NOT registered with the Sumo Logic service. Once the Collector is registered, refer to the user.properties parameters table column Can be changed after installation? to see the settings that can be changed with a Collector restart.

When using the Collector 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).

Creating user.properties

After downloading the Collector binary package (e.g. tarball), create the user.properties file in a specific directory. 

To create user.properties:

  1. Using a text editor (or any similar program) create a new file.
  2. Add all of the required parameters and any optional parameters listed in the table in this topic.
  3. Save the file to <Collector Installation Directory>/config/user.properties

Default Collector Installation Location

The following are the default Collector installation locations:

Linux:
/opt/SumoCollector/
or 
/usr/local/SumoCollector

Windows:
C:\Program Files (x86)\Sumo Logic Collector
or
C:\Program Files\Sumo Logic Collector

user.properties examples

Using Access ID and Access Key registration.  For binary package installation, you must also specify the command to run the JRE, or JRE path if it does not exist on your $PATH:

name = My Collector
accessid = [accessId]
accesskey = [accessKey]
wrapper.java.command = java

Using access ID and access key registration, proxy settings, and custom JRE configuration:

name = My Collector
accessid = [accessId]
accesskey = [accessKey]
proxyHost = 10.0.0.8
proxyPort = 3128
wrapper.java.command = /opt/java_1.7/bin/java
wrapper.java.maxmemory = 2048

user.properties parameters

The following table lists all of the parameters available in the user.properties file.

Parameter Description Examples

wrapper.java.command=[JRE Bin Location]

Sets the JRE binary to use when starting the Collector.

Use the default system Java version: wrapper.java.command=java

Use a specific JRE installation (Linux): wrapper.java.command=/opt/java_1.7/bin/java

Use a specific JRE installation (Windows): wrapper.java.command=C:\\Program Files (x86)\\Java\\jre7\\bin

Key-value parameters (key=value). Add as needed.

Parameter Description Can be changed after installation?

name=[name]

Sets the name of Collector used on Sumo Logic.

No, use Edit the Collector or the Collector Management API to modify

url=[url]

Sets URL used to register Collector for data collection API.

No

token=[token]

Sets Setup Wizard Token used when logging in with one-time-use token.

This is not the the encoded Token+URL. It is the decoded token only.

No

accessid=[accessId]

Sets access ID used when logging in with Access ID and Key.

No

accesskey=[accessKey]

Sets access Key used when logging in with Access ID and Key.

No

proxyHost=[host]

Sets proxy host when a proxy server is used.

Yes, with Collector restart

proxyPort=[port]

Sets proxy port when a proxy server is used.

Yes, with Collector restart

proxyUser=[username]

Sets proxy user when a proxy server is used with authentication.

Yes, with Collector restart

proxyPassword=[password]

Sets proxy password when a proxy server is used with authentication.

Yes, with Collector restart

proxyNtlmDomain=[NTLM domain]

Sets proxy NTLM domain when a proxy server is used with NTLM authentication.

Yes, with Collector restart

sources=[filepath]

Sets the JSON file describing sources to configure on registration. Important: On Windows the path value for "sources=" must be specified with double slashes, \\, for example:

sources=c:\\sumo\\sources.json

No

syncSources=[filepath]

Sets the JSON file describing sources to configure on registration, which will be continuously monitored and synchronized with the Collector's configuration. Important: On Windows the path value for "sources=" must be specified with double slashes, \\, as shown in the example. Refer this link for details about local configuration mode

No

ephemeral=[true/false]

When true, the Collector will be deleted after 12 hours of inactivity. See Setting a Collector as Ephemeral for more information.

No, use the Collector Management API to modify

clobber=[true/false]

When true, if there is any existing Collector with the same name, that Collector will be deleted. See Forcing a Collector's Name with Clobber for more information.

No, use the Collector Management API to modify

hostName=[hostname]

* Available on Collector version 19.182+

The host name of the machine on which the Collector is running. The host name can be a maximum of 128 characters.

No, use the Collector Management API to modify

timeZone=[timezone]

* Available on Collector version 19.182+

The time zone to use when it cannot be extracted from the time stamp.
Example:

timeZone=America/Los_Angeles

For a list of possible values, refer to the "TZ" column in this Wikipedia article.

No, use the Collector Management API to modify

category=[category]

* Available on Collector version 19.182+

Source category to use when a source does not specify a category.

No, use the Collector Management API to modify

targetCPU=[target]

* Available on Collector version 19.182+

You can choose to set a CPU Target to limit the amount of CPU processing a Collector uses. The value must be expressed as a whole number percentage.
Example:

targetCPU=20

The Collector will adjust resources to attempt to limit the CPU usage to at most 20%.  For more information, see Set the Collector CPU Usage Target.

No, use the Collector Management API to modify

description=[description]

* Available on Collector version 19.182+

Description for the Collector to appear in Sumo Logic.

No, use the Collector Management API to modify

disableScriptSource=[true/false]

If your organization's internal policies restrict the use of scripts, you can disable the running of script-based Sources. When this parameter is passed, Script Source will not execute on this Collector.

Yes, with Collector restart

disableActionSource=[true/false]

If your organization's internal policies restrict the use of script actions, you can disable the creation of script-based Action Sources. When this parameter is passed, Action Source will not execute on this Collector.

Yes, with Collector restart

disableUpgrade=[true/false]

If true, the Collector rejects upgrade requests from Sumo Logic.

Yes, with Collector restart


(Optional) JVM or wrapper configuration parameters

Parameter Description Can be changed after installation?

wrapper.java.initmemory=[size]

Sets the initial java heap size (in MB). Default: 64

 

Yes, with Collector restart

 

wrapper.java.maxmemory=[size]

Sets the maximum java heap size (in MB). Default: 128

Yes, with Collector restart