Splunk® DB Connect

Deploy and Use Splunk DB Connect

Download manual as PDF

This documentation does not apply to the most recent version of DBX. Click here for the latest version.
Download topic as PDF

Migrating from DB Connect v1 to DB Connect v2

DB Connect v2 has been rewritten from the ground up, which means that upgrading to DB Connect v2 from DB Connect v1 actually installs the new version alongside the old one. You will notice significant changes in DB Connect v2. In particular, be aware of the following:

  • DB Connect v2 has a different app ID (splunk_app_db_connect) versus DB Connect v1 (dbx). The app ID dictates, among other things, the name of the add-on's directory in the $SPLUNK_HOME/etc/apps directory.
  • Installing the current version of Splunk DB Connect does not remove DB Connect v1. In fact, you can run the two versions in parallel as you acclimate to the new version. However, this is not recommended as a long-term strategy.
  • Your configurations from the previous version do not automatically transfer to the new version. To learn how to migrate your configurations from DB Connect v1 to DB Connect v2, see Migrate from DB Connect v1.
  • Configuration files have changed format and will need to be migrated or re-created. For more information about the new configuration file formats, see Configuration file reference. To learn how to migrate your configuration files from DB Connect v1 to DB Connect v2, see Migrate from DB Connect v1.
  • The output format template for specifying how database output is logged by Splunk Enterprise has been removed. Instead, use standard search commands to format the output. For example, to specify that data be output as key-value pairs, use eval. To change the quoting pattern, use rex.
  • In DB Connect v2, there is no longer a spool option to configure. Data is transferred on the fly, and then modular inputs receive the data via standard in.

For more information about how this version of DB Connect works, see How Splunk DB Connect works.

To learn how to migrate your DB Connect v1 settings to DB Connect v2, see Migrate from DB Connect v1.

For a summary of where settings have moved in DB Connect v2 .conf files, see Configuration file reference.

DB Connect UI changes

The DB Connect user interface has gone through significant changes between version 1.x.x ("v1") and version 2.0.x ("v2"). This section summarizes those changes. Each of the following subsections is based on the corresponding menu item in DB Connect v1, and describes where each of its contents now resides.

DB Connect v1 menu bar: Dbx1 menu.png

DB Connect v2 menu bar: Dbx2 menu.png

Splunk DB Connect

  • Java Bridge server status: Removed in v2. The Java Bridge server is no longer required, and has been removed. Instead, DB Connect v2 has added an RPC Server status indicator to the menubar.
  • Manage database connections: You now access your database connections under the Explorer tab in DB Connect v2.
  • Explore database schema > DB Info: In DB Connect v2, instead of the DB Info view, you can interactively inspect the structure of your databases when you set up your database inputs, outputs, and lookups, in the "Choose and preview table" or "Search for the Splunk fields to output" steps.
  • Explore database schema > DB Query: In DB Connect v2, instead of the DB Query view, you run SQL queries when you create database inputs, outputs, and lookups, in the "Choose and preview table" or "Search for the Splunk fields to output" steps.
  • Add database inputs: To add or edit database inputs, in DB Connect v2 go to Operations > DB Inputs.

Search

The Search tab is a shortcut to the Splunk Enterprise Search & Reporting app. It is unchanged in DB Connect v2.

Database Info

In DB Connect v2, instead of the Database Info view, you can interactively inspect the structure of your databases when you set up your database inputs, outputs, and lookups, in the "Choose and preview table" or "Search for the Splunk fields to output" steps.

Database Query

In DB Connect v2, instead of the Database Query view, you run SQL queries when you create database inputs, outputs, and lookups, in the "Choose and preview table" or "Search for the Splunk fields to output" steps.

Searches menu

DB Connect Debug Log: To learn how to enable debug logging and view the debug log in DB Connect v2, see Enable debug-level logging.

Recent DB Connect errors: DB Connect v2 features a health dashboard, which allows you to monitor failures, errors, and the status of many other connection properties. To access the health dashboard, click Health in the DB Connect v2 menu bar. To learn more about the health dashboard, see Monitor database connection health.

Recent Java Bridge errors: Because the Java Bridge server is no longer required, this option is no longer needed and has been removed. Instead, DB Connect v2 has added an RPC Server status indicator to the menubar.

Settings menu

Splunk DB Connect configuration: You now access DB Connect configuration settings under the Settings tab in DB Connect v2.

Java Bridge Server Status: Because the Java Bridge server is no longer required, this option is no longer needed and has been removed. Instead, DB Connect v2 has added an RPC Server status indicator to the menubar.

Manage Database connections: To view and manage database connections in DB Connect v2, go to Explorer > Connections.

Manage Database inputs: To view and manage database inputs in DB Connect v2, go to Operations > DB Inputs.

Manage Database lookups: To view and manage database lookups in DB Connect v2, go to Operations > DB Lookups.

PREVIOUS
Share data in Splunk DB Connect
  NEXT
How Splunk DB Connect works

This documentation applies to the following versions of Splunk® DB Connect: 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.2.0, 2.3.0, 2.3.1, 2.4.0, 2.4.1


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

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