Set Up Troubleshooting Tools for DB Connect
The troubleshooting tool for DB Connect is a delivered python package that requires installation. Note that if you don't have an internet connection, you will need to install the python dependencies for offline environments, and you can find details later in this guide. The installation package can be found in troubleshooting-tools/troubleshooting_tools-<version>-py3-none-any.whl
under the bin
directory.
Some of the tools require the use of the connector.jar
, which comes delivered with DB Connect and can be found in troubleshooting-tools/connector.jar
under the bin
directory.
Compatible Databases
- DB2
- MySQL
- Microsoft SQL Server
- Oracle
- PostgreSQL
- Redshift
- Snowflake
Requirements
SPLUNK_HOME
as environment variable- JRE 11+ (required only by Troubleshoot Connections and Troubleshoot Inputs)
- Python 3.7+
Install
Install dependencies in offline mode
$ pip install --no-index --find-links troubleshooting-tools/wheelhouse -r troubleshooting-tools/requirements.txt
Install troubleshooting-tools package
$ pip install troubleshooting-tools/troubleshooting_tools-<version>-py3-none-any.whl
Run troubleshooting-tools
$ python3 -m troubleshooting_tools.start
Tools
Troubleshoot Starts
Shows the status of any services or dependencies required for DB Connect to start.
- Java
- KV Store
- Keystore
Services Status
Shows the status of any services or dependencies used for DB Connect.
- KV Store
- Keystore
- HEC
- Search API
Troubleshoot Connections
Shows the status of a specific connection to the database.
Info required:
- Connection name: one of the available connections in DB Connect.
- Connector path: location of the
connector.jar
. - JDBC path: location of the JDBC driver compatible with the selected connection.
Troubleshoot Inputs
Shows the status of a specific input.
Info required:
- Input name: one of the available inputs in DB Connect.
- Connector path: location of the
connector.jar
. - JDBC path: location of the JDBC driver compatible with the selected connection.
Troubleshooting Tools for DB Connect | Common issues for Splunk DB Connect |
This documentation applies to the following versions of Splunk® DB Connect: 3.11.0, 3.11.1
Feedback submitted, thanks!