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. Click here for the latest version.
Acrobat logo Download topic as PDF

Set Up Troubleshooting Tool for DB Connect

The troubleshooting tool for DB Connect enables you to use a command line utility for troubleshooting your own configuration for DB Connect, saving you time and effort.

Compatible Databases

  • Oracle
  • MS SQL
  • Postgres
  • MySQL
  • MemSQL


  • You have an existing connection in DB Connect (click 'save anyway' even if there is an error).
  • You have added the JDBC driver for your connection to the 'drivers' folder in DB Connect.
  • You have CLI access to the instance you want to test.
  • You should have Java 8 or higher JDK installed and can run the 'javac' command from the CLI.

Configuration Steps

These are the troubleshooting tool configuration steps for both Windows and Mac/Linux.

On Windows

  1. Navigate to the $SPLUNK_HOME\etc\apps\splunk_app_db_connect\bin directory in DB Connect.
  2. Make sure the following environment variables are defined and have the following paths:
    1. JAVA_HOME: C:\Program Files\Java\jdk1.7.0_79\bin
    2. PATH: C:\Program Files\Java\jdk1.7.0_79\jre\bin\server
    3. PATH: C:\Program Files\Java\jdk1.7.0_79\bin
    4. Download and install Microsoft Visual C++ Build Tools (command-line tools subset of Visual Studio) for Python 3.5 and 3.6: https://visualstudio.microsoft.com/downloads/

On Mac/Linux

  1. Navigate to the $SPLUNK_HOME/etc/apps/splunk_app_db_connect/bin directory in DB Connect.

Access the troubleshooting tool

  1. Run 'python dbx_connection_diag.py' or 'python3 dbx_connection_diag.py' or 'py dbx_connection_diag.py' depending on how your python3 command is set up.
  2. Choose the JDBC driver associated with the connection you wish to test. The utility should show all of the drivers in the DB Connect 'Drivers' directory.
  3. Provide the credentials for the local Splunk instance. The user will need to be an administrator.
  4. After verifying that DB Connect is installed on the local Splunk instance, you will be shown the connections available for testing. Choose the connection you want to test.
  5. Provide the database password for the user shown (This will be the user associated with this database connection).
  6. The utility will attempt to ping the database server. If successful, you will be shown the current settings for the database connection and be given a chance to modify them.
  7. The results of the test along with diagnosis and recommendations will display.
Last modified on 27 October, 2021
Troubleshooting Tool for DB Connect
Common issues for Splunk DB Connect

This documentation applies to the following versions of Splunk® DB Connect: 3.7.0

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