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 the Splunk platform versions 8.1.0 and higher.
- KV store must also be active and working properly as of DB Connect version 3.10.0 and higher.
- Splunk DB Connect will not work in a FIPS compliant environment, regardless of whether Splunk is FIPS compliant or not.
- You can change your Python version to ensure compatibility with your version of Splunk Enterprise or Splunk Cloud Platform.
Operating systems and browsers
Splunk DB Connect runs on 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 the 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. You need a license to see your data while configuring your inputs, perform lookups, and configure outputs. 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.
Before using DB Connect, a logged-in user must have the ability to write to the to the following directories and their sub directories:
$SPLUNK_HOME/var directory (
%SPLUNK_HOME%\var on Windows hosts) and to
%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, meet the following requirements:
- Download and install one of the following compatible versions of the Java Runtime Environment:
- Java Platform, Open Java Development Kit (OpenJDK) 11 from the OpenJava Project.
- Java Platform, Java Runtime Environment (JRE) 17 from Java Platform, Standard Edition
- Java Platform, Open Java Development Kit (OpenJDK) 17 from the OpenJava Project.
- Java Platform, Java Runtime Environment (JRE) 18 from Java Platform, Standard Edition
- Java Platform, Open Java Development Kit (OpenJDK) 18 from the OpenJava Project.
- Java platform, AdoptOpenJDK 17 the AdoptOpenJDK Project
- Java platform, AdoptOpenJDK 18 the AdoptOpenJDK Project
- Java platform, Azul JDK 17 the Azul JDK product
- Java platform, Azul JDK 18 the Azul JDK product
- Download and install a supported database driver, and run locally or elsewhere on your network.
Configure Java Runtime Environment (JRE) for Splunk DB Connect
- Download and install a compatible version of the Java Runtime Environment (JRE).
Note: For best performance, make sure to use server mode (default in OpenJDK), rather than client mode.
- Configure JRE to ensure that Splunk DB Connect can find it and start the Java processes.
Option 1: Set
JAVA_HOMEenvironment variable, pointing to JRE installation directory.
Option 2: Add JRE bin directory to the
PATHsystem variable, e.g.
Option 3: Set JRE installation directory in Configuration > Settings > JRE Installation Path.
Validate JRE installation
java --version from the command line, it should return information about the Java installation.
openjdk 11.0.16 2022-07-19
OpenJDK Runtime Environment Homebrew (build 11.0.16+0)
OpenJDK 64-Bit Server VM Homebrew (build 11.0.16+0, mixed mode)
Troubleshooting JRE configuration
If JRE is installed and configured correctly, but Splunk DB Connect does not start, check the logs.
SPLUNK_HOME/var/log/splunk/splunkd.log and look for
ERROR related to
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:
- If your Cloud Stack is version 8.2.2107 or below, then you have Java 8 installed.
- If your Cloud Stack is version 8.2.2109 or above, then you have Java 11 installed.
- 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
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 new drivers using JDBC Driver addons JDBC driver add-ons.
For information about connecting to unsupported databases with Splunk DB Connect, see Other databases.
How to get help and learn more about Splunk software
Architecture and performance considerations
This documentation applies to the following versions of Splunk® DB Connect: 3.15.0