Splunk AppInspect overview

Splunk AppInspect evaluates your Splunk app against a set of Splunk-defined criteria so that you can be assured of its quality and robustness. AppInspect runs various checks on your app package, and then produces a report that clearly details any missed criteria. AppInspect ensures that your Splunk app is ready for production use on your own Splunk Enterprise instance, or for submission to Splunkbase.

Notes:

  • For more information about developing Splunk apps, see the resources page in this documentation.
  • AppInspect supports the Splunk Packaging Toolkit. The Packaging Toolkit is a tool for authoring, packaging, and validating a Splunk app to help improve app management, including installation, configuration, and updating.
  • The App Certification program ended in August, 2018. All apps will now be processed through AppInspect before being published to Splunkbase. For details, see App certification retirement FAQs.

AppInspect evaluates all of the following for a given Splunk app:

Splunk AppInspect takes two forms. Both are recommended for all Splunk app developers to ensure quality apps.

  • AppInspect API

    The AppInspect API is a RESTful API to which you can submit a Splunk app package to be automatically validated in preparation for submission to Splunkbase. The AppInspect API has the added benefit of using dynamic analysis—your Splunk app is installed on a virtual Splunk Enterprise instance—for higher fidelity. You must be connected to the Internet to call AppInpect API to vet your Splunk app.

  • AppInspect CLI tool

    The AppInspect CLI tool is a stand-alone Python package that can be downloaded and installed locally on your Linux, Mac, or Windows machine. The AppInspect CLI tool does not call the AppInspect API to perform checks and therefore does not require a network connection. It's ideal for testing Splunk apps while you're developing them.

Note:
  • Using AppInspect API and running the AppInspect CLI tool to vet your Splunk app may produce slightly different check results, since AppInspect API also installs your app on a virtual Splunk Enterprise instance to perform dynamic analysis/runtime checks on it. It is highly recommended that you always use AppInspect API to perform app checks for higher fidelity when connected to the Internet.
  • Splunk AppInspect is not supported by Splunk. The AppInspect CLI tool is offered without warranty, and according to the End User License Agreement (EULA) included with the download. The AppInspect service is maintained as a best effort, but has no explicit SLA. For more information about getting help with using Splunk AppInspect, see Get help with the AppInspect CLI tool.