Splunk® Enterprise

Upgrade Readiness

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Install the Splunk Python Upgrade Readiness App

Install the Python Upgrade Readiness App on all instances of your Splunk platform deployment that run apps or on a single test Splunk platform instance with all your apps installed on it.

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.


  • Splunk Enterprise version 7.3, 8.0, or 8.1 with apps or add-ons installed.
  • KV store must be enabled.
  • A role must hold the admin_all_objects capability to install the app. The admin role holds this capability by default.
  • Consider increasing the splunkd session timeout value, depending on the number of custom apps in the environment. For details, see performance considerations.

Performance considerations

To limit the performance impact of running scans, install the Python Upgrade Readiness App on a single test Splunk platform instance. Install all of your apps and add-ons on this test instance, then install the Python Upgrade Readiness App and run scans there.

Memory usage and scan time are proportional to the cumulative size of the Python files across all of your apps. For example, a Splunk Enterprise 7.3.0 instance with about 9,000 Python files across 15 apps can take about 75-100 minutes to complete a scan. Since the user session timeout limit is 60 minutes by default, to ensure the user session does not timeout during the app scan, increase the session timeout limit before scanning large numbers of apps, as mentioned in the preceding requirements section. For more information, see Configure user session timeouts

Scan time increases significantly when rescanning the same set of apps, if the apps have not been modified.

Install the app on a non-clustered Splunk Enterprise instance

To install the app on an non-clustered search head, forwarder, or single-instance Splunk Enterprise deployment:

  1. Download the Splunk Python Upgrade Readiness App from Splunkbase.
  2. In Splunk Web, click the App gear icon.
  3. Click Install app from file.
  4. Locate the app installation package and click Upload.
  5. Restart Splunk.
    The app now appears in the list of apps in the Splunk Web UI.

Install the app on a search head cluster

To install the app on a search head cluster, use the deployer. For detailed instructions, see Use the deployer to distribute apps and configuration updates in the Distributed Search manual.

Next, see Manage permissions for the Python Upgrade Readiness App.

Last modified on 19 November, 2021
About the Splunk Python Upgrade Readiness App
Manage permissions for 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, 8.2.3

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