System requirements

Before you install this version of Splunk DB Connect, your environment must meet the requirements listed in this topic.

Splunk platform requirements

• This version of Splunk DB Connect is compatible with Splunk Platform versions 7.2.0 and later.
• Splunk DB Connect is compatible with Splunk Cloud.
• Splunk DB Connect is not compatible with Splunk Light.
• Splunk DB Connect is compatible with Splunk servers configured for FIPS compliance.
• You can change your python version to ensure compatibility with Splunk versions, if necessary.

Operating systems and browsers

Splunk DB Connect runs Windows and *nix-based operating systems. For version details, see supported operating systems of Splunk Enterprise.

You can use the following browsers to use Splunk DB Connect on your Splunk platform:

• Apple Safari (latest)
• Google Chrome (latest)
• Microsoft Internet Explorer 11
• Mozilla Firefox (latest)

Splunk licenses and DB Connect

If you configure Splunk DB Connect to import data from a connected database into a Splunk Enterprise index, the amount of data Splunk Enterprise indexes counts towards your Splunk Enterprise license. Using the dbxquery, dbxlookup, and dbxoutput commands against a connected database in DB Connect does not count towards the license.

For more information about Splunk licenses, see How Splunk licensing works.

Splunk DB Connect Release Notes

For the latest known issues and fixed problems in Splunk DB Connect, see Release Notes.

User permissions

Before using DB Connect, a logged-in user must have the ability to write to the $SPLUNK_HOME/var directory (%SPLUNK_HOME%\var on Windows hosts) and to $SPLUNK_HOME/etc/apps/splunk_app_db_connect (%SPLUNK_HOME%\etc\apps\splunk_app_db_connect on Windows hosts) and its sub-directories. For more information, see Use access control to secure Splunk data.

Java Runtime Environment (JRE) requirements

Before deploying Splunk DB Connect:

• Download and install one of the following compatible versions of the Java Runtime Environment:
  • Java Platform, Java Runtime Environment (JRE) 8 from Java Platform, Standard Edition (deprecated).
  • Java Platform, Open Java Development Kit (OpenJDK) 8 from the OpenJava Project (deprecated).
  • Java Platform, Java Runtime Environment (JRE) 11 from Java Platform, Standard Edition.
  • Java Platform, Open Java Development Kit (OpenJDK) 11 from the OpenJava Project.

• Download and install a supported database driver, and run locally or elsewhere on your network.

Java Runtime Environment (JRE) version 8 from Oracle

1. Download and install the Server Java Runtime Environment version 8 from Oracle. Only use a supported JVM in server mode, not in client mode.
2. Once you have installed the JRE, write down the path to the JRE directory, or $JAVA_HOME. You need the file path when you are configuring DB Connect. When DB Connect prompts you to input the JRE Installation path in Configuration > Settings, be sure to input the complete JRE file path you wrote down.

OpenJDK 8 from the Open Java Development Kit project

1. Download and install the [1] version 8 from the OpenJDK project. Only use a supported JVM in server mode, not in client mode.
2. Once you have installed the JRE, write down the path to the JRE directory, or $JAVA_HOME. You need the file path when you are configuring DB Connect. When DB Connect prompts you to input the JRE Installation path in Configuration > Settings, be sure to input the complete JRE file path you wrote down.

Java Runtime Environment (JRE) version 11 from Oracle

1. Download and install the Server Java Runtime Environment version 11 from Oracle. Only use a supported JVM in server mode, not in client mode.
2. Once you have installed the JRE, write down the path to the JRE directory, or $JAVA_HOME. You need the file path when you are configuring DB Connect. When DB Connect prompts you to input the JRE Installation path in Configuration > Settings, input the complete JRE file path you wrote down.

OpenJDK 11 from the Open Java Development Kit project

1. Download and install the OpenJDK version 11 from the OpenJDK project. Only use a supported JVM in server mode, not in client mode.
2. Once you have installed the JRE, write down the path to the JRE directory, or $JAVA_HOME. You need the file path when you are configuring DB Connect. When DB Connect prompts you to input the JRE Installation path in Configuration > Settings, be sure to input the complete JRE file path you wrote down.

Java Runtime Environment (JRE) for Splunk DB Connect running on Splunk Cloud Victoria Experience

DB Connect running on Search Heads inside a Splunk Cloud Victoria Experience will use the JRE that is already installed on the Search Head:

1. If your Cloud Stack is version 8.2.2107 or below, DB Connect will be using Java 8.
2. If your Cloud Stack is version 8.2.2109 or above, DB Connect will be using Java 11.
3. If there are any issues with the installed Java version, file a support ticket.

If you are unsure whether you have the correct version of Java installed, access DB Connect setup. On the first screen of the DB Connect setup or at Configuration > Settings > General you can specify the path to your JRE. If there is a problem with the Java install or the system $JAVA_HOME variable is incorrect, DB Connect displays an error message. It is important that you resolve any JRE issues before proceeding as DB Connect uses Java Database Connectivity (JDBC) to communicate with your databases.

Database and JDBC database driver requirements

Splunk DB Connect supports connections to many databases. You must install a Java Database Connection (JDBC) driver or a JDBC driver add-on for your database before you can connect to databases with DB Connect.

For more information about the databases that Splunk DB Connect supports, see Supported databases.

For more information about the JDBC driver add-ons, see JDBC driver add-ons.

For information about connecting to unsupported databases with Splunk DB Connect, see Other databases.