Configuration file reference
Splunk DB Connect includes the following custom configuration spec files:
- app-migration.conf.spec
- db_connection_types.conf.spec
- db_inputs|db_inputs.conf.spec
- db_outputs|db_inputs.conf.spec
- db_lookups.conf.spec
- identities.conf.spec
- inputs.conf.spec
- dbx_settings.conf.spec
The most current versions of these spec files exist in the $SPLUNK_HOME/etc/apps/splunk_app_db_connect/README/
folder, %SPLUNK_HOME%\etc\apps\splunk_app_db_connect\README\
directory on Windows.
Configuration files for version upgrades
Configuration files for Splunk DB Connect have changed in DB Connect version 3. DB Connect does not transfer your configuration files to the new version automatically. See Migrate DB Connect deployment to DB Connect 3.0.0
The following sections describe the .conf files where settings existed in previous versions of DB Connect, and where they exist in DB Connect version 3.
DB Connect version 2 configuration files
- app-migration.conf: Specifies options for migrating from DB Connect 1.x.x to DB Connect 2.x.x.
- db_connection_types.conf: Lists the database types, driver parameters, and test queries DB Connect supports.
- db_connections.conf: Stores all configuration necessary for connecting to a specific database, unless overridden by parameters from identities.conf.
- healthlog.conf: Manages the behavior of the self-monitoring health dashboard in DB Connect.
- identities.conf: Stores credentials that DB Connect uses to connect to databases in the standard Splunk Enterprise credential store.
- inputs.conf: Configures database indexing, lookup, and output behavior using modular inputs. Also includes per-input Java options.
DB Connect version 3 configuration files
- app-migration.conf: Specifies options for migrating from DB Connect 2.x.x to DB Connect 3.x.x.
- db_connection_types.conf: Lists the database types, driver parameters, and test queries that DB Connect supports.
- db_connections.conf: Stores all configuration necessary for connecting to a specific database, unless overridden by parameters from identities.conf.
- db_inputs.conf: Configures database indexing behavior using modular inputs.
- db_lookups.conf: Configures database lookup behavior using modular inputs.
- db_outputs.conf: Configures database output behavior using modular inputs.
- inputs.conf: Keeps the Task Server running using modular inputs.
- identities.conf: Stores credentials DB Connect uses to connect to databases in the standard Splunk Enterprise credential store. (The credentials are obfuscated hash text.)
For more information about configuration files, see About configuration files in the Splunk Enterprise Admin Manual. For more information about how Splunk Enterprise determines which configuration files take precedence, see Configuration file precedence in the Splunk Enterprise Admin Manual.
Monitor Splunk DB Connect health | app-migration.conf.spec |
This documentation applies to the following versions of Splunk® DB Connect: 3.8.0, 3.9.0, 3.10.0
Feedback submitted, thanks!