Step 2: Create your app
The Splunk app framework works from a specific directory structure. You can create the directory structure by hand within your
$SPLUNK_HOME/etc/apps directory. However, you can also use the Splunk app builder to create and customize your app workspace. App builder creates the directory structure for you, as well as the
app.conf configuration file that registers your app with your Splunk server.
Use app builder
App builder is available from Settings. To use app builder in Splunk Web, follow these instructions:
1. Log in to Splunk Web and navigate to Apps > Manage Apps.
2. Click Create app.
3. Specify the following in the Add new panel.
- Name: The name for your app. The name maps to the label setting in
app.confand is the name that appears in Launcher and the App drop-down menu in Splunk Web.
- Folder name: The name to use for the directory in $SPLUNK_HOME.
The name of the folder cannot contain the "dot" (
.) character .
- Visible: Apps containing views should be marked visible.
- Description: A description of the app. Previous versions of Splunk Enterprise display the description on the Splunk Home page. The current version of Splunk Enterprise does not use the description. If you plan to upload your app to Splunkbase, supply a description. Splunkbase uses the description to validate an app package.
- Template: Splunk provides the
sample_appincludes sample views and saved searches.
barebonesjust provides the app directory structure and an
app.conffile. You can add additional customized templates.
- Note: The
4. Save your app.
- You do not have to restart Splunk before your app is available, but you may need to restart Splunk to load configurations.
5. Continue building out your app in Step 3: add configurations.
Step 1: Getting started
Step 3: Add configurations
This documentation applies to the following versions of Splunk® Enterprise: 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.0.6, 6.0.7, 6.0.8, 6.0.9, 6.0.10, 6.0.11, 6.0.12, 6.0.13, 6.0.14, 6.0.15, 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.1.10, 6.1.11, 6.1.12, 6.1.13, 6.1.14, 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8, 6.2.9, 6.2.10, 6.2.11, 6.2.12, 6.2.13, 6.2.14, 6.2.15