Splunk® Add-on Builder

Splunk Add-on Builder User Guide


Splunk App Certification Failure in the Add-on Builder for Splunk SDK for Python 1.6.6

Steps to reproduce

Create an Add-on in the Add-on Builder version 3.x.x and later and rebuild the same add-on in Add-on Builder 4.1.4 or later. The Add-on Builder show this validation error for Splunk SDK for Python v1.6.6 even if it is using an upgraded version.

To mitigate the issue

For Splunk SDK related failures, upgrade the Add-on Builder to 4.2.0 or later version and edit any Rest API input or Python Scripted input in the Add-on Builder once, without any changes. This allows the Add-on Builder to rebuild the add-on and update the python libraries in the Add-on Builder.

Splunk App Certification Failures in the the Add-on Builder : "Check v1 deprecated API usages" and "Detect usage of Javascript libraries with known vulnerabilities"

Steps to reproduce

Create an Addon in AOB version 3.x.x and later rebuild the same addon in the Add-on Builder 4.x or later.

To mitigate the issue

  1. Upgrade to the Add-on Builder version 4.2.0 or later.
  2. Delete the common.js file from the path: "$SPLUNK_HOME/etc/apps/<TA_NAME>/appserver/static/js/build"
  3. Edit any Rest API input or Python Scripted input in the Add-on Builder once without any changes. This will allow the Add-on Builder to rebuild the add-on.

Lost configuration field values after migration to version 4.x

When configuration fields for Add-ons created using the Add-on Builder are encrypted in version 3.x and the are again accessed using Add-on Builder version 4.x, the value for that configuration field is presented as ***** instead of the actual value. This issue only occurs when the Add-on Builder is upgraded from version 3.x to 4.x.

Steps to reproduce

  1. In the Add-on Builder version 3.x, a modular input is created using python code that contains any field whose value will be stored in the .conf file after encryption.
  2. The field is saved to the .conf file with the values from the user interface.
  3. The Add-on Builder is upgraded to version 4.x
  4. When the saved field value is accessed, the value is fetched as **** instead of the actual value.

To mitigate the issue

Reconfigure the configurations after upgrading to add-on builder version 4.x.

Error message when importing an Add-on in the Add-on Builder

The following error is seen when importing the Add-on in the Add-on Builder: The addon project cannot be imported because a problem occurred while loading the metadata.

Conditions under which this issue may occur

An Add-on is created in Add-on Builder using the "VALIDATE & PACKAGE" option (which only downloads the installable .spl file) instead of the "EXPORT" option (which actually exports the project along with its metadata). The app project was deleted from the UI of Add-on builder and tried to import the .spl file for the same project.

To mitigate this issue

Re-create your add-on in the project using Add-on Builder.

'PROXY_TYPE_HTTP_NO_TUNNEL' message after upgrading from version 4.1.0 to version 4.1.1

When you try to create REST API inputs after upgrading from version 4.1.0 to version 4.1.1, the API error may be seen:

AttributeError: module 'socks' has no attribute 'PROXY_TYPE_HTTP_NO_TUNNEL'

To mitigate this issue

  1. Delete the socks.py files present under the locations:
    • $SPLUNK_HOME/etc/apps/<YOUR_ADDON>/bin/ta_<your_addon>/aob_py3/socks.py
    • $SPLUNK_HOME/etc/apps/splunk_app_addon-builder/bin/ta_generator/resources_lib/aob_py3/socks.py
  2. Create the input again.
Last modified on 05 April, 2024
Use the add-on   Create a new data model

This documentation applies to the following versions of Splunk® Add-on Builder: 4.2.0

Was this topic useful?

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