Splunk® Platform Upgrade Readiness App

Use the Splunk Platform Upgrade Readiness App

Download manual as PDF

Download topic as PDF

About the Splunk Platform Upgrade Readiness App

Use the Splunk Platform Upgrade Readiness App to prepare your Splunk platform instance for upgrade to the next version. The Upgrade Readiness App scans selected Splunk apps installed on a Splunk Enterprise version 7.1, 7.2, 7.3, 8.0, or 8.1 instance for features and code that will not work in some versions of the Splunk platform.

The scan results describe how to take action to ensure the apps and customizations you are responsible for work as expected after you upgrade to a new version of the Splunk platform. For example, the scan results indicate if any apps and customizations rely on Python 2. This is important because support for Python 2 is being phased out. The Splunk Enterprise version 8.0 release includes both the Python 2.7 and Python 3.7 runtimes to help customers transition from Python 2 to Python 3. The Splunk Enterprise 8.1 release removes the Python 2.7 runtime altogether.

For more information about the Splunk Enterprise Python 3 release, see Python 3 migration with the Splunk platform.

The Splunk Platform Upgrade Readiness App is tool for assisting with your transition between Python 2 and Python 3. Even if your deployment passes all checks, you still need to independently test your private and customized apps and add-ons for incompatibilities.

What the scan checks for

The Upgrade Readiness App checks for:

  • Use of Advanced XML
  • Use of SplunkWeb legacy mode
  • The existence of files named test.py
  • Dependency on the Swig or M2Crypto modules
  • Use of custom Mako templates
  • Use of custom CherryPy endpoints
  • Python scripts

For more information about these checks and what to do with the results, see Scan your instance with the Splunk Platform Upgrade Readiness App.

What apps are included in the scan

When you install the Splunk Platform Upgrade Readiness App on a Splunk platform instance, it scans all apps and add-ons in the $SPLUNK_HOME/etc/apps folder, with some exceptions. The app scans the private apps that you have created for your own organization as well as apps that you have installed from Splunkbase, whether they are third-party apps or Splunk Supported apps. The scan includes disabled apps.


Even if you have them installed, the Upgrade Readiness App excludes the following apps from the scan:

  • Python for Scientific Computing
  • Search & Reporting
  • Splunk App for Infrastructure
  • Splunk App for PCI Compliance
  • Splunk App for VMWare
  • Splunk Business Flow
  • Splunk Cloud Gateway
  • Splunk Enterprise Security
  • Splunk Industrial Asset Intelligence
  • Splunk IT Service Intelligence

See also

To get started, see Install the Splunk Platform Upgrade Readiness App.

For instructions on how to use the app, see Scan your instance with the Splunk Platform Upgrade Readiness App.

For information about features, fixed issues, and known issues in this app, see the Release notes for the Splunk Platform Upgrade Readiness App.

Last modified on 28 August, 2020
Install the Splunk Platform Upgrade Readiness App

This documentation applies to the following versions of Splunk® Platform Upgrade Readiness App: 2.1.0, 2.2.0

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