Splunk® DB Connect

Deploy and Use Splunk DB Connect

Acrobat logo Download manual as PDF

This documentation does not apply to the most recent version of Splunk® DB Connect. For documentation on the most recent version, go to the latest release.
Acrobat logo Download topic as PDF

Configure DB Connect settings

This topic explains how to setup DB Connect before you use it to access databases.

General tab

  1. Access Configuration > Settings.
  2. The General Settings tab contains settings related to your Java Runtime Environment (JRE) and Task Server. Change any settings you wish. When DB Connect 3.0.0 prompts you to input the JRE Installation path, be sure to input the complete JDK filepath. Refer to Prerequisites for further details.
  3. Click Save to restart the Task Server's Java process. You do not need to restart Splunk Enterprise for changes on this page to take effect.

JRE Installation Path (JAVA_HOME)

This field contains the path leads to the Java home directory. If you are using a system-wide Java, there may be a $JAVA_HOME variable which you can use in this field. DB Connect attempts to detect and construct the JRE path, if possible.

If you get an error after entering a path and saving your configuration, verify the path to your Java installation. Different platforms have different requirements, such as

  • Windows C:\Program Files\Java\jdk1.8.0_121
  • OSX /Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home/jre
  • Linux /opt/jdk1.8.0_121/jre/

JVM Options

This field lists Java Virtual Machine parameters. For more information about available JVM parameters, access Oracle's JVM documentation.

DB Connect saves the options in this field in $DB CONNECT_HOME/jars/server.vmopts.

Note: As for a knows issue in DB Connect 3, if your inputs from the table contains Non-ASCII characters, you need to set the JVM option as -Dfile.encoding=UTF-8 manually.

Task Server Port

This field contains the port number of the task server. DB Connect uses an RPC server to manage communications with the Java subsystem. The default port is 9998, but you can use any unassigned, unused port on your system.

Drivers tab

This tab contains a list of supported database connection types, along with install status and version number information.

If there is no JDBC driver for a connection type, the Installed column shows an X icon and the word "No". By default, there are no drivers.

  1. To install a JDBC driver, follow the instructions in "Install database drivers."
  2. Once you have moved the appropriate JAR file to the $SPLUNK_HOME/etc/apps/splunk_app_db_connect/drivers directory, click the Reload button.

If you have installed a JDBC driver and it still does not register:

When DB Connect detects a driver, it displays a green checkmark icon and the word "Yes" next to the database, as shown in the screen shot below. It also displays the version information of the driver. Driverstab.jpg


As of version 3.0.0, DB Connect provides graphical configurations of the logging levels of DB Connect. DB Connect logs activity to files in $SPLUNK_HOME/var/log/splunk and automatically indexes to _internal. The relevant log files for DB Connect are:

  • splunk_app_db_connect_server.log
  • splunk_app_db_connect_job_metrics.log
  • splunk_app_db_connect_dbx.log
  • splunk_app_db_connect_audit_server.log

By default, DB Connect logs all SQL queries it executes at the INFO level. You can enable other logging levels using the UI below.

Usage Collection tab

This tab contains an option to grant permission for Splunk to collect statistics about how you use DB Connect. See sending usage data to Splunk DB Connect to learn more about the data that DB Connect sends to Splunk.

Last modified on 31 May, 2017
Distributed deployment
Configure security and access controls

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

Was this documentation topic helpful?

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