Skip to main content
Sumo Logic

user.properties

For collector versions 19.137 and later, the user.properties file lets you pass collector configuration parameters to Sumo during installation, if the collector is NOT registered with the Sumo Logic service. 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 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. Use a text editor (or any similar program) to create a new file.
  2. Add required parameters and any desired optional parameters listed in user.properties parameters below.
  3. Save the file to CollectorInstallationDirectory/config/user.properties

Default collector installation Location

The default collector installation locations are:

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

The example below sets the Access ID and Access Key. When installing a binary package, you must specify the command to run the JRE, or the JRE path if it does not exist on your $PATH:

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

The example below sets the Access ID and Access Key, proxy settings, and a custom JRE.

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.

Note that, as of collector v19.182-17, accesskey is automatically removed from user.properties following successful installation.

If you configure a collector to be ephemeral, in the event that the collector is de-registered after 12 hours offline, you will need to re-add the accesskey to user.properties.

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

Specifies a single JSON file that defines the sources to configure upon collector registration. 

On Windows, the path value for "sources=" must be specified with double slashes, \\, for example:

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

No

syncSources=filepath or folderpath

Specifies either a single JSON file, or a folder containing JSON files, that define the sources to configure upon collector registration. The source definitions will be continuously monitored and synchronized with the collector's configuration. 

On Windows the path value for "sources=" must be specified with double slashes, \\. 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.

Note that after the collector is de-registered after 12 hours of inactivity, you must update user.properties to add the accesskey property. As noted above, in the accesskey row, Sumo removes accesskey from user.properties when the collector successfully registers with Sumo.

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 sources will not execute on this collector.

Yes, with collector restart

disableUpgrade=true/false

If true, the collector rejects upgrade requests from Sumo.

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