Splunk® Enterprise

Upgrade Readiness

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Share data in the Upgrade Readiness App

When you deploy the Upgrade Readiness App on Splunk Enterprise, the app sends anonymized usage data to Splunk Inc. ("Splunk"), which can help to improve the Upgrade Readiness App in future releases. For instructions on how to opt in or out of data collection, and for more information on how usage data is collected, stored, and governed, see Share data in Splunk Enterprise

What data is collected

Component Description Example
app.pythonupgradereadiness.scan Finds your version of the Upgrade Readiness App and the amount of time in minutes that your scans take. Also, gathers metadata on the types of apps that you scan, such as if your apps are from Splunkbase or not, and the results of the app scans.
{
   "appVersion": "3.1.0",
   "scanType": "All",
   "scanTypeModified": true,
   "executionTime": 0,
   "summary": {
     "appListDate": "1615448661",
     "skippedAppsNumber": 33,
     "scanFrequency": {
        "am_pm": "AM",
        "day": 2,
        "hours": 12,
        "minutes": 30
      },
     "frequencyUpdateTime": "None",
     "stackDefaultPython": "force_python3"
   },
   "errors": {
     "status": "",
     "errorMessage": ""
   },
   "apps": [
     {
       "name": "SomePublicApp",
       "version": "3.0.0",
       "status": "PASSED",
       "details": "This app is compatible with Python 3.",
       "type": "Splunkbase-Dual",
       "meta": {
         "source": "Splunkbase",
         "appStatus": "PASSED",
         "MakoXMLStatus": "PASSED",
         "MakoNumber": 0,
         "PythonScriptStatus": "PASSED",
         "PythonScriptNumber": 0,
         "skipped": true,
         "dismissedApp": 0,
         "dismissedAppDate": "",
         "pythonSDKVersion": ""
       }
     },
     {
       "name": "XXXXXXXXXXX",
       "version": "XXXXXXXXXXX",
       "status": "BLOCKER",
       "details": "This app is not compatible with Python 3.",
       "type": "Private App",
       "meta": {
         "source": "Private",
         "appStatus": null,
         "skipped": true,
         "dismissedApp": 0,
         "dismissedAppDate": "",
         "MakoXMLStatus": "PASSED",
         "MakoNumber": 0,
         "PythonScriptStatus": "WARNING",
         "PythonScriptNumber": 5,
         "pythonSDKVersion": "1.6.13"
        }
     }
   ]
 }
app.jQueryupgradereadiness.scan Finds your version of the Upgrade Readiness App and the amount of time in minutes that your scans take. Also, gathers metadata on the types of apps that you scan, such as if your apps are from Splunkbase or not, and the results of the app scans.
{
    "appVersion": "3.1.0",
    "scanType": "All",
    "scanTypeModified": true,
    "summary": {
      "appListDate": "1631587094",
      "scanFrequency": {
        "day": "1",
        "hours": "6",
        "minutes": "39",
        "am_pm": "PM",
        "disabled": 0,
        "time_offset": "+05:30",
        "is_updated": true,
        "_key": "613b56fdc97d8c08e8095461"
      },
      "frequencyUpdateTime": "1631279258"
    },
    "errors": {
      "status": "",
      "errorMessage": ""
    },
    "apps": [
      {
        "name": "XXXXXXXXXXX",
        "version": "XXXXXXXXXXX",
        "status": "PASSED",
        "details": "This app is compatible with jQuery 3.5",
        "type": "Private App",
        "meta": {
          "source": "Private",
          "appStatus": "PASSED",
          "skipped": false,
          "dismissedApp": 0,
          "dismissedAppDate": "",
          "JQueryDashboardStatus": "PASSED",
          "JQueryDashboardNumber": 0,
          "JQueryVersionStatus": "PASSED",
          "JQueryVersionNumber": 0,
          "InternalLibraryStatus": "PASSED",
          "InternalLibraryNumber": 0
        }
      },
      {
        "name": "app_ilog-scanner",
        "version": "1.0.3",
        "status": "BLOCKER",
        "details": "This app is not compatible with jQuery 3.5.",
        "type": "Splunkbase-Warning",
        "meta": {
          "source": "Splunkbase",
          "appStatus": "BLOCKER",
          "skipped": false,
          "dismissedApp": 0,
          "dismissedAppDate": "",
          "JQueryDashboardStatus": "BLOCKER",
          "JQueryDashboardNumber": 1,
          "JQueryVersionStatus": "PASSED",
          "JQueryVersionNumber": 0
        }
      }
    ]
}
app.emeraldupgradereadiness.scan Finds your version of the Upgrade Readiness App and the amount of time in minutes that your scans take. Also, gathers metadata on the types of apps that you scan, such as if your apps are from Splunkbase or not, and the results of the app scans.
{
component: app.emeraldupgradereadiness.scan
   data: {
    appVersion: 4.0.0
    apps: [
       {
         details: This app is compatible with Splunk platform versions 9.0 and higher.
         meta: {
         EmeraldPythonTLSNumber: 0
           EmeraldPythonTLSStatus: PASSED
           appStatus: PASSED
           dismissedApp: 0
           dismissedAppDate:
           skipped: false
           source: Splunkbase
         }}
         name: drivelock
         status: PASSED
         type: "Splunkbase-None
         version: 3.0.0
       }
       {
         details: "This app is not compatible with Splunk platform versions 9.0 and higher.
         meta: {
           EmeraldPythonTLSNumber: 22
           EmeraldPythonTLSStatus: BLOCKER
           appStatus: BLOCKER
           dismissedApp: 0
           dismissedAppDate:
           skipped: false
           source: Private
         }
         name: XXXXXXXXXXX
         status: BLOCKER
         type: "Private App
         version: XXXXXXXXXXX
       }
     scanType: All
     scanTypeModified: true
     summary: {
       appListDate: NA
       frequencyUpdateTime: 1650445763
       scanFrequency: {
         _key: 625fcdc35cfe5863541208c1
         am_pm: PM
         day: 1
         disabled: 0
         hours: 2
         is_updated: true
         minutes: 41
         time_offset: +05:30
       }
     }
   }
   deploymentID: da4c994b-6583-5eb4-90fb-8db3562ce08a
   eventID: 02566678-3BBC-4A9E-AF5A-8D5D715F9D7E
   executionID: AA7540C6-1B71-4A7A-AA00-1C8A2434CBF6
   optInRequired: 2
   timestamp: 1650446944
   type: event
   userID: 0b560ff586cc2a91c7961b090598c621958099c576595f4bdfe9fc77914633ec
   visibility: [
     anonymous
     support
   ]
}

Last modified on 02 June, 2022
PREVIOUS
Release notes for the Upgrade Readiness App
  NEXT
Credits for the Upgrade Readiness App

This documentation applies to the following versions of Splunk® Enterprise: 9.0.0, 9.0.1, 9.0.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