Skip to main content

sumo.conf for Legacy Collectors

For legacy Collectors (releases prior to 19.137), the sumo.conf file allows you to pass Collector configuration parameters to Sumo during installation.

To authenticate Collectors, you must include an access ID and access key. See [Access Keys](/docs/manage/security/access-keys for information on generating and managing access keys.

Creating sumo.conf

After downloading the Collector installer, you'll create the sumo.conf file in a specific directory.

To create sumo.conf:

  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 in UTF-8 encoding to /etc/sumo.conf (Mac or Linux) or C:\\sumo\\sumo.conf (Windows).
note

Some scripting utilities, such as PowerShell, default to ANSI. Make sure that the file is saved in UTF-8 encoding.

tip

You can comment out lines in sumo.conf, use the # character at the beginning of line.

sumo.conf parameters

The following parameters can be passed to Sumo Logic using sumo.conf.

You cannot have blank values, like name= .

ParameterDescriptionExampleRequired/Optional
nameName used to register the Collector. If no name is specified, the hostname is used. The hostname can be a maximum of 128 characters.name=FirewallLogsOptional
accessidAccess ID generated in the Security page. See Access Keysaccessid=MboxeezMzN8SRequired
accesskeyAccess ID generated in the Security page. See Access Keysaccesskey=dBorwTn8TxF8ofounEXnsQ4hPpuqCzwRequired
sourcesPath to JSON file that contains Source configuration. See JSON Source Configuration.
Important: On Windows the path value for "sources=" must be specified with double slashes, \, as shown in the example.
sources=c:\\sumo sources.json (Windows)Optional
overrideOverrides a Collector's existing Sources to delete all Sources except for the one specified by the sources parameter (above).
Important: Don't include this parameter in sumo.conf unless necessary. Override results in Source deletion and re-creation with collector restart, and causes significant re-ingestion of already ingested data.
override=trueOptional
ephemeralWhen set to true, the Collector will be deleted after 12 hours of inactivity. See Setting a Collector as Ephemeral for more information.ephemeral=trueOptional
clobberSets the clobber flag; don't include unless you'd like to clobber the Collector. See Forcing a Collector's Name with Clobber for more information.clobber=trueOptional
proxyHostSets the host the Collector uses to connect via a proxy.proxyHost=hostNameOptional
proxyPortThe port number a Collector uses to connect via a proxy.proxyPort=portNumberOptional
proxyUserThe user name a Collector uses to connect via a proxy.proxyUser=userNameOptional
proxyPasswordThe password associated with the proxyUser setting.proxyPassword=passwordOptional
proxyNtlmDomainWhen using an NTML proxy, the URL used to connect.proxyNtlmDomain=sumoexchange.comOptional
syncSourcesWhen using the Local File Configuration management method, provides the file path and the name of the JSON file that contains all Source information for the Collector.syncSources=[file path]/sources.jsonOptional
url=[url]Sets URL used to register Collector for data collection API.url=https://collectors.eu.sumologic.comOptional
Sumo Logic YouTubeSumo Logic Twitter
Legal
Privacy Statement
Terms of Use

Copyright © 2022 by Sumo Logic, Inc.