Skip to main content

Local Configuration File Management

With local configuration file management, you can configure Sources for an Installed Collector in one or more UTF-8 encoded JSON files.

After you switch over to local configuration file management, you can no longer manage Sources through the Sumo web application or the Collector Management API. In the Sumo web application, the Add Source option is disabled on the Manage Data > Collection > Collection page.

note

Local configuration file management is available on Collector version v19.108 and later.

Benefits of local configuration file management​

If you’re an experienced admin, local configuration file management is a quick way to set up or edit Sources across your deployment.

  • You don’t need to log in to the Sumo web app or use API calls. Instead, you edit the JSON configuration file(s), and they are read almost immediately by the Collector.
  • If you have a large scale deployment, it can be impractical to add or edit Sources one at a time. Using local configuration management allows you to manage Sources more easily.
  • You can use deployment tools so that established policies for deployments are not interrupted.

Options for specifying Sources in local configuration file(s) ​

There are two ways to implement local configuration file management:

  • Specify all Sources in a single UTF-8 encoded JSON file. 
  • Use multiple UTF-8 encoded JSON files to specify your Sources, and put all of those files in a single folder. You can put each Source definition in its own file, or define multiple sources per file if you like. 

Each JSON file must have a .json extension, for example:

source1.json

For example JSON configurations, see Use JSON to Configure Sources. The topic includes a table of common parameters that apply to all Source types and links to the topics that describe the parameters for specific Source types.

The configuration files remain on the Collector and are checked nearly constantly for any changes.

note

Before deploying your configuration to production Collectors, check it out in a test environment. Errors in the JSON can cause problems, including deletion of Sources.

Define one Source in a JSON file​

 This is an example of a JSON file that defines a single Source.

{
"api.version":"v1",
"source":{
"sourceType":"LocalFile",
"name":"Example1",
"pathExpression":"/var/logs/maillog"
}
}

Define multiple Sources in a JSON file​

When you define multiple Sources in a JSON file, you can define each Source in a sources JSON array.

{
"api.version":"v1",
"sources":[
{
"sourceType":"LocalFile",
"name":"Example1",
"pathExpression":"/var/logs/maillog"
},{
"sourceType":"LocalFile",
"name":"Example2",
"pathExpression":"/var/logs/syslog"
}
]
}
note

The maximum number of Sources allowed on a Collector is 1,000.

To set up new Collectors and Sources see Local Configuration File Management for New Collectors and Sources. 

To convert existing Sources from Cloud Management to Local Configuration File Management see Local Configuration File Management for Existing Collectors and Sources.

Configure the location of JSON file or folder​

When using local file configuration management you specify the location of the JSON file or the folder that contains multiple JSON files in the Collector’s config/user.properties file. You need to use the syncSources parameter to point to your configuration file or folder. See user.properties for details on all of the available parameters.

  • syncSources. Use to define the Sources to configure upon Collector registration. The Source definitions will be continuously monitored and synchronized with the Collector's configuration. 

    • On *nix, to point to a JSON file that defines Sources for a Collector:

      syncSources=/path/to/sources.json

    • On *nix, to point to a folder that contains JSON files that define Sources for a Collector:

      syncSources=/path/to/sources-folder

    • On Windows (note the escaped backslashes), to point to a folder that contains JSON files that define Sources for a Collector:

      syncSources=C:\\path\\to\\sources-folder\\

Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.