Step 2: create your app
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Contents
Step 2: create your app
Splunk's 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 Splunk's app builder to create and customize your app workspace. App builder will create the directory structure for you, as well as the app.conf configuration file that registers your app with your Splunk server.
Use app builder
You'll find app builder in Splunk Manager, in the Apps section. To use app builder in Splunk Web, follow these instructions:
1. Log in to Splunk Web and navigate to Splunk Manager (click the Manager link in the upper right-hand corner).
2. Click on Apps.
3. Hit the Create app... button to create a new app.
4. Enter a ID for your app. For example, helloworld. This name will be the name of your app's directory in $SPLUNK_HOME/etc/apps/. For example, now you'll have a $SPLUNK_HOME/etc/apps/helloworld.
5. Enter a Name for your app. This label maps to the label setting in app.conf and will become the name of your app in Launcher and the app drop-down menu in Splunk Web. Label and name can be the same, for example set the label to Hello world.
6. Pick an app template. Choose between the sample_app app template or the barebones app template.
- sample_app: includes several sample views and saved searches, providing you with a sample app to build from.
- barebones: just gives you the app directory structure and an app.conf. All other files you'll build yourself.
7. Add images, assets or files. For any files you don't specify, app builder uses the template's defaults. You can:
- Add an image for the banner background. This image will tile in the banner section. There are more banner images located in the
$SPLUNK_HOME/share/splunk/appserver/static/directory. - Upload another image. Reference the image in any view or dashboard with HTML.
- Upload application.css. Use this file to Customize your app's CSS.
- Upload assets. You can add any HTML, JavaScript or other valid file format that you want to reference from within your app.
8. Save your app. You do not have to restart Splunk before your app is available, but you may need to restart to load configurations.
9. Continue building out your app in Step 3: add configurations.
This documentation applies to the following versions of Splunk: 4.1 , 4.1.1 , 4.1.2 , 4.1.3 , 4.1.4 , 4.1.5 , 4.1.6 , 4.1.7 , 4.1.8 View the Article History for its revisions.