With local configuration file management, all configuration is done through a configuration file. This approach allows you to create scripts to configure multiple Collectors and Sources or to create configuration backups.

If you are using local configuration file management, you cannot use the API or the Sumo web app to modify the configuration.

Step 2. Update user.properties

When a Collector starts it reads the syncSources parameter from the user.properties configuration file to determine the file path of the JSON file or folder with the Source configurations. The user.properties file is located in the Collector's config folder.

Prior to version 19.137, the Collector used the sumo.conf file for Source configuration. If you are installing a legacy Collector, see sumo.conf for information.

Parameter

Type

Description

syncSources

String

Sets the JSON file describing sources to configure on registration, which will be continuously monitored and synchronized with the Collector's configuration.

To add the syncSources parameter

Open or create the user.properties file located at <CollectorInstallationFolder>/config.

Add the following:syncSources=/path/to/sources.json
On Windows systems, use a double-backslash for the file path:syncSources=C:\\path\\to\\sources.json

Save and close the file.

Step 3. Make the switch

You can now move to the local configuration file management option, using the Sumo web application or the Collector Management API.

Do one of the following:

In the Sumo web app, choose Local Configuration File in the Edit Collector dialog box.

In the Collector Management API, use the PUT method to update the Collector's sourceSyncMode to "Json". For more information, see Collector API Methods and Examples. The following example shows the sourceSyncMode of a Collector using UI mode:

Step 4. Restart the Collector

Step 5. Verify the Sources are configured properly

Examine the Collector log file to verify that the Collector is ingesting data from all Sources.

Editing the configuration file

You can edit the JSON configuration file at any time to edit Source attributes or add new Sources. When you delete Sources from the file they are deleted from the Collector.

After you finalize changes to the sources.json file, test the changes by deploying this configuration file to a Collector on a host that is NOT in production. After the file is validated, deploy the file to each host with Sources that need to be modified by overwriting the existing sources.json file. Collectors continually watch for updates to the sources.json file for changes. Any edits are immediately processed.

Recommended articles

Sumo Logic is the industry’s leading secure, cloud-native, machine data analytics service, delivering real-time, continuous intelligence across the entire application lifecycle and stack. More than 1,000 customers around the globe rely on Sumo Logic for the analytics and insights to build, run and secure their modern applications and cloud infrastructures.