Check DB Connect installation health
Beginning with version 3.1.0, DB Connect provides health checks for the Splunk Access and customize health check to help you diagnose common issues.
- The Monitoring Console is only visible to users with the Splunk Enterprise admin role.
- The health check feature is available with Splunk version 6.5 and higher.
To use the health check, go to Settings of your Splunk instance and select Monitoring console. On the monitoring console page, select Health Check tab. There are seven configured health check items provided by DB Connect. You can check the health of these items by selecting DB Connect and clicking Start, or leave the filters blank to run all available health checks.
The Splunk DB Connect health check items are:
- DB Connect connection configuration.
Checks that database connection configurations (identities and connections) are syntactically correct and that you can resolve all dependencies between stanzas.
- Data lab configuration.
Checks that data access configurations (inputs, outputs, lookups) are syntactically correct and that you can resolve all dependencies between stanzas.
- Configuration entries with incorrect syntax don't display in the user interface, and you must correct them using configuration files.
- JDBC driver installation.
Checks that connections configured in DB Connect have the corresponding JDBC driver and version installed correctly.
- DB Connect file permission.
Checks the existence and permission settings of the folders that the DB Connect processes needs to read and write: DB Connect application folder, checkpoint folder and log folder.
- JVM installation.
Checks the existence and version of the JVM that you configured DB Connect to use to run individual commands and the Task Server.
- Java server configuration.
Checks the JVM bootstrap conditions of the DB Connect Task Server.
- Kerberos environment configuration.
Checks the configuration file for Kerberos is correctly configured to support Microsoft Active Directory authentication. This item is only performed on Linux servers when at least one database connection uses Kerberos.
After the health check process is complete, the result summary (how many succeeds, how many errors or warning messages) displays on the page. You can expand each health check item to see the detailed result.
Example 1: After checking all the health check items, all the health check items are successful.
Example 2: After checking all the DB Connect health check items, there are some issues in Data lab configuration and JDBC driver installation.
You can expand the health check item JDBC driver installation, it shows the error messages and suggested action provided by Splunk. You can also view the details of the issue in the Result table.
Besides installation health check, DB Connect also provides pre-built panels for you to monitor DB Connect input health, input performance and the connection health with the database. See Monitor database connection health for details.
Backup and restore Splunk DB Connect >=3.10.0
Go through the given scenario to understand how to create a DB Connect backup and restore it.
- We have two server,
- Splunk DB Connect is installed and configured in server
- We need to migrate Splunk DB Connect from server
Backup and restore:
- Install Splunk DB Connect in the server
- Make sure all Splunk JDBC Add-ons present in server
Aare installed in
- Backup the input's checkpoints from the KV Store in server
$SPLUNK_HOME/bin/splunk backup kvstore -collectionName dbx_db_input -archiveName <backup-name>. The backup file will be stored in
- Copy the input's checkpoint backup to
- Restore the input's checkpoints to the KV Store in server
$SPLUNK_HOME/bin/splunk restore kvstore -collectionName dbx_db_input -archiveName <backup-name>.tar.gz.
- Backup the secrets from the KV Store in server
$SPLUNK_HOME/bin/splunk backup kvstore -collectionName secret -archiveName <backup-name>. The backup file will be stored in
- Copy the secret's backup to
- Restore the secrets to the KV Store in server
$SPLUNK_HOME/bin/splunk restore kvstore -collectionName secret -archiveName <backup-name>.tar.gz.
- Stop Splunk.
- Copy each
- Copy each
- Start Splunk.
Install and configure Splunk DB Connect on Splunk Cloud Platform
Backup and restore Splunk DB Connect version 3.10.0 or higher
This documentation applies to the following versions of Splunk® DB Connect: 3.14.0, 3.14.1