Splunk® Add-on Builder

Splunk Add-on Builder User Guide

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of AddonBuilder. Click here for the latest version.
Acrobat logo Download topic as PDF

Use the Splunk Add-on Builder

The home page of the Splunk Add-on Builder displays all of the add-on projects that were created using the Splunk Add-on Builder, along with any other apps and add-ons that have been installed on your instance of Splunk Enterprise.

AddonBuilder homepage.png

The progress of each add-on project is displayed as a completion percentage, along with other basic properties. You can search for apps and add-ons by name, and sort the order in which they are displayed.

  • Click Create a project to begin building an add-on using the Add-on Builder.
  • Click an existing Add-on Builder project to continue working on it.
  • Click the X on an Add-on Builder project to delete it.
  • Click a user-installed app or add-on to validate it using the Add-on Builder.


The Splunk Add-on Builder guides you through the workflow of building an add-on. You must complete each section in order, but you can revisit and modify your work as needed. The workflow is divided into the following sections:

AddonBuilder step1.png
Use the Name Project section to set basic properties for your add-on project.
AddonBuilder step2.png
Use the Configure Data Inputs section to get data into your add-on by configuring data inputs. You can also configure setup options for your add-on.
AddonBuilder step3.png
Use the Add Sample Data section to add sample data for your data inputs so that you can create knowledge object from your data.
AddonBuilder step4.png
Use the Extract Fields section to create field extractions from the data inputs you configured.
AddonBuilder step5.png
Use the Map to CIM Data section to map the fields from the field extractions to the common information model (CIM).
AddonBuilder step6.png
Use the Validate section to validate the add-on for best practices, and test the modular/scripted inputs, field extractions, and CIM mappings. The Splunk Add-on Builder shows you any errors or warnings, along with recommendations about how to address them.
AddonBuilder step7.png
Use the Summarize section to package the add-on when you are ready to install your add-on and use it. The result is a compressed file that contains a directory with the necessary configuration files.
Last modified on 28 June, 2016
PREVIOUS
What to know before you build add-ons
  NEXT
Name Project

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


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