Splunk® Enterprise

Upgrade Readiness

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

About the Splunk Python Upgrade Readiness App

Use the Python Upgrade Readiness App to prepare your Splunk platform instances for upgrade to Python 3. This app scans the selected apps installed on a Splunk Enterprise version 7.3, 8.0, or 8.1 instance for features and code that might not work with Python 3.

The app's scan results describe the actions you must take to ensure that the your apps work as expected after you upgrade to a new version of the Splunk platform. For example, scan results show if any apps and customizations rely on Python 2. This is important as support for Python 2 is being phased out of Splunk software.

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

The Python Upgrade Readiness App is a tool that assists you with your transition from Python 2 to Python 3. Even if your deployment passes all checks, you must still independently check both your private and customized apps and add-ons for incompatibilities.

The Python Upgrade Readiness app comes with Splunk Enterprise version 8.2 and higher. You do not need to install the app on this version of Splunk Enterprise.

What the scan checks for

The Python Upgrade Readiness App checks for:

  • Python 3 incompatible code in custom Mako templates.
  • Python scripts that might fail in Python 3.

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

Which apps does the scan include

This app scans all apps and add-ons in the $SPLUNK_HOME/etc/apps and $SPLUNK_HOME/etc/slave-apps directories, with some exceptions. The app scans both private apps that you have created for your own organization, as well as public apps installed from Splunkbase, including third-party apps and Splunk supported apps.


This 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
  • Splunk Platform Upgrade Readiness App
  • Splunk RapidDiag
  • Splunk Secure Gateway
  • Splunk Add-on Builder

See also

To get started, see Install the Python Upgrade Readiness App.

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

For information about features, fixed issues, and known issues in this app, see Release notes.

Last modified on 17 August, 2021
Install the Splunk Python Upgrade Readiness App

This documentation applies to the following versions of Splunk® Enterprise: 8.2.0, 8.2.1, 8.2.2

Was this documentation topic helpful?

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