App upgrade issue

[shub_loginsoft]

Hi Splunk Community,

We've developed a new version of our Splunk app and recently published it to Splunkbase. However, we're facing issues when upgrading the app via Manage Apps in Splunk Web.

---

What's happening:

• After upgrading the app, it stops functioning .
• We've added new input fields to the setup page (setup.xml), but these changes do not reflect immediately in the UI after upgrade. The new fields only show up after clearing the browser cache and doing a hard reload.
• Interestingly, if we completely remove the old version of the app and do a fresh install of the new version from Splunkbase, everything works perfectly — the setup UI loads correctly, and logs appear as expected.

  Any suggestion would be highly appreciated.
  
  Thanks

[shub_loginsoft]

Hi @livehybrid ,

Thanks for the reply.

We've already updated the build version and deployed it to the marketplace. Trying to understand why it's causing issues during an update, while working perfectly on a fresh install.

[livehybrid]

Hi

To ensure that the app's webUI components are reloaded in the UI after an upgrade you need to make sure that both the version number in the app.conf is updated (which I suspect you have done if you've updated it on Splunkbase!) but also the build=<numeric> in the [launcher] in app.conf - this will force the cache to be cleared for the app and I've found previously that this can help with cached pages such setup.xml and any associated Javascript.

Example app.conf snippet:

[launcher]
version = 2.1.0
build = 210

Browsers can still cache aggressively, so instruct users to do a hard refresh (Ctrl+Shift+R or Cmd+Shift+R) after upgrade if the above does not take effect.

For more info on build key in app.conf check out the docs at https://docs.splunk.com/Documentation/Splunk/latest/Admin/Appconf#:~:text=performed.%0A*%20Default%3...

🌟Did this answer help you? If so, please consider:

• Adding kudos to show it was useful
• Marking it as the solution if it resolved your issue
• Commenting if you need any clarification

Your feedback encourages the volunteers in this community to continue contributing

[shub_loginsoft]

Hi @livehybrid 

We have updated the launcher version and the install build in app.conf as part of the latest release of the TA-ipqualityscore app. However, during the upgrade process (from a previous version to the latest), we're encountering the following error in splunkd.log:

04-04-2025 14:32:37.142 +0530 ERROR ChunkedExternProcessor [209108 ChunkedExternProcessorStderrLogger] - stderr: ImportError: cannot import name 'IPQualityScoreClient' from 'ipqualityscoreclient' (/opt/splunk/etc/apps/TA-ipqualityscore/bin/ipqualityscoreclient/__init__.py)

This issue seems to occur only during an upgrade. When the app is installed as a fresh install from Splunkbase, it works without any errors.

 Could you please assist in identifying the root cause and recommend the appropriate fix?