Splunk® DB Connect

Deploy and Use Splunk DB Connect

Download manual as PDF

This documentation does not apply to the most recent version of DBX. Click here for the latest version.
Download topic as PDF

Configuration file reference

Splunk DB Connect includes the following custom configuration spec files:

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.

For upgraders

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.

PREVIOUS
Monitor database connection health
  NEXT
app-migration.conf.spec

This documentation applies to the following versions of Splunk® DB Connect: 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0, 3.1.1, 3.1.2


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters