Upgrade and downgrade Splunk DB Connect

How to upgrade Splunk DB Connect

Throughout the life of DB Connect we have had to adapt to changes in architecture and functionality, so we have implemented migration logic to make these updates transparent to Customers. However, for simplicity and to reduce the time spent on maintenance and implementation of migrations, in some cases it is not possible to migrate from one version to another. We recommend reviewing the table described below to help with the upgrade process.

Upgrade paths to version 4.x.x

Review the following table carefully to choose the right migration path for your case. Versions 3.10.0 and 3.14.0, which are not shown here, introduced major disruptive changes.

When upgrading to version 4.x.x, ensure that all checkpoints were migrated, as checkpoint migration logic was removed starting with version 4.0.0 to reduce complexity. For versions higher than or equal to 3.10.0 and earlier than 3.18.5 checkpoints are not migrated at startup; instead, they are migrated only when the input execution is triggered.

Current version First upgrade Second upgrade Latest available Release notes
2.x.x 3.9.0 3.18.5 4.x.x

3.9.0

3.18.5
3.x.x 3.18.5 4.x.x 3.18.5
Note: If you upgraded Splunk DB Connect in Splunk Cloud using an unsupported upgrade path (for example, directly from version 3.9.x to 4.x.x), a temporary downgrade may be required to complete the necessary migrations. In such cases, you can downgrade from version 4.x.x to version 3.18.x, so the Java services can perform the required migration steps. After this migration completes, you should upgrade the app again to version 4.x.x. Note that while the app is running on version 3.18.x during this process, the Splunk DB Connect UI may become unavailable and data ingestion may stop due to Python compatibility limitations. This behavior is expected, and once the application is upgraded again to version 4.x.x, normal functionality, including the UI and data ingestion should be restored.

Downgrade from DB Connect version 3.14.0 or higher to DB Connect version 3.13.0 or lower

Note: If you are running version 4.x.x and you want to follow this procedure, first you must downgrade to version 3.18.5.

Due to changes related to encryption algorithm introduced in 3.14.0, if you need to downgrade to a version prior to 3.14.0 you must perform the following steps:

  1. Open $SPLUNK_HOME/etc/apps/splunk_app_db_connect/local/dbx-migration.conf in edit mode.
  2. Go to the [encryption] stanza and change downgrade from NONE to PENDING.
  3. Restart Splunk DB Connect.

Upgrade from DB Connect version 3.13.0 or lower to DB Connect version 3.14.0 or earlier than 4.x.x, if you've previously downgraded Splunk DB Connect

  1. Open $SPLUNK_HOME/etc/apps/splunk_app_db_connect/local/dbx-migration.conf in edit mode.
  2. Go to the [encryption] stanza and change upgrade from DONE to PENDING.
  3. Restart Splunk DB Connect.

Note: For more useful information, you can refer to $SPLUNK_HOME/etc/apps/splunk_app_db_connect/README/dbx-migration.conf.spec.