settings.conf.spec

The settings.conf file contains DB Connect settings such as the $JAVA_HOME path, the JVM Options string, and Splunk usage collection. These settings can also be configured in DB Connect on the Settings page.

# Version 2.2
#
# This file contains possible attributes and values you can use to configure
# Splunk DB Connect's behaviors.
#
# There is a settings.conf in $SPLUNK_HOME/etc/apps/splunk_app_db_connect/default/.
# To set custom configurations, place a settings.conf in
# $SPLUNK_HOME/etc/apps/splunk_app_db_connect/local/. For examples, see settings.conf.example.
# You must restart Splunk to enable configurations.
#
# To learn more about configuration files (including precedence) please see
# the documentation located at
# http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles

[settings]
java_home = <string>
# Path of Java home

jvm_options = <string>
# JVM options to be applied in Splunk DB Connect


[usage_collection]
# Set Party.js configuration options under this stanza name.
# Follow this stanza name with any number of the following attribute/value pairs.
# If you do not specify an entry for each attribute, default value will be used.

mode = [On | Off | None]
# The mode of analytics data collection with Party.js.
#   On       - data will be collected. Splunk admins can opt out via the UI.
#   Off      - data will not be collected. Splunk admins can opt in via the UI.
#   None     - data will not be collected. Awaiting Splunk admin opt in or out.
# A pop-up will show when the Splunk admin visits the "Settings" page for the first time.
# Defaults to None.

app_id = <uuid_string>
# A UUID used to identify the Splunk DB Connect instance.
# This will be generated automatically when the Splunk admin opts in the first time.

interval_<string> = <integer>
# smallest interval of two logs of same category in seconds

settings.conf.example

The following is an example settings.conf file.

# Version 2.2
#
# This is an example settings.conf.  Use this file to configure
# Splunk DB Connect settings.
#
# To use one or more of these configurations, copy the configuration block
# into settings.conf in $SPLUNK_HOME/etc/apps/splunk_app_db_connect/local/.
# You must restart Splunk to enable configurations.
#
# To learn more about configuration files (including precedence) please see
# the documentation located at
# http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles

[settings]

java_home = /usr/local/bin/java
jvm_options = -Xmx256m -Dfile.encoding=UTF-8 -server -Duser.language=en -Duser.region=


[usage_collection]

# usage collection is enabled.
mode = On

# the automatically generated app ID.
app_id = f2682864-5d3e-428c-a256-d51edbe3f90b

# smallest interval of two system logs in seconds
interval_system = 3600