Overview of Splunk AppInspect

Welcome to Splunk AppInspect!

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 as either a standard or certified app.

Note: For more information about developing Splunk apps, see the resources page in this documentation.

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

Splunk AppInspect takes two forms:

  • The AppInspect stand-alone Python package ("AppInspect CLI tool") can be downloaded and installed locally on your Linux, Mac, or Windows machine. It's ideal for testing Splunk apps while you're developing them.
  • 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 and app certification. 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.

Running the AppInspect CLI tool or using the AppInspect API is recommended for all Splunk app developers to ensure quality apps and expedited Splunkbase acceptance and app certification.

Note: 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.

AppInspect CLI tool

The Splunk AppInspect CLI tool is available for Linux, Mac, and Windows. Fixing issues that AppInspect finds in your Splunk app can both result in a higher quality Splunk app and allow your Splunk app to more quickly be accepted or certified by Splunk.

For more information about the AppInspect CLI tool, see the following topics in this documentation:

AppInspect API

The AppInspect API provides a mechanism for Splunk app developers to submit an app package via a RESTful API in preparation for submission to Splunkbase and app certification. In addition to the functionality that the AppInspect CLI tool provides, the API provides you with dynamic analysis checks. The API validates the contents of the package and provides a report against standardized certification criteria, including whether the app installs successfully onto instances of Splunk Enterprise and Splunk Cloud.

For more information about the AppInspect API, see the following topics in this documentation: