Step 1: Getting started
You have a lot of options when building your app. First and foremost, decide on your app's scope and use case. To get you started, here's a high level view of how to build an app for Splunk. For more specifics, read through each step and the how-tos in this section.
What you need
You can jump right into building an app with the app builder in Splunk's Manager interface, but you may also want to carefully plan out and build your app. If so, here are a few things you might want to set up before you get started.
- An editor for XML, CSS, and HTML files
- You can build apps entirely within Splunk Web, but if you want to create custom XML, CSS or HTML you may want to use an editor designed for those formats.
- Starting with Splunk 4.3, Splunk provides an XML editor available from Splunk Web. This editor provides syntax highlighting and auto-indent features. This editor opens when you edit XML files from Splunk Web.
- For all formats, Splunk recommends Komodo Edit -- it's free, cross-platform, and supports text highlighting for a variety of standard formats.
- Useful, relevant data
- Index some data to showcase in your app.
- Build knowledge around this data and present this knowledge through your app's UI.
- For example, if you're building an app for your custom firewall data, set up a data input to index this data. You can optionally set up a custom index to keep this data segregated from the rest of your Splunk install.
- Splunk knowledge objects
- Objects include data visualization components, like saved searches and reports, as well as UI components to display these, such as views and dashboards.
- Web development tools
- If you're doing advanced customization, we strongly suggest you use one of these tools.
- If you're using Firefox, you'll want to check out Firebug.
- IE8 has a built-in console in the Tools menu, under Developer Tools.
- Safari 4 also has a built-in console. First you have to enable the develop menu for the menu bar under Preferences > Advanced Tab. Check Show Developer Menu in menu bar. Then select Develop > Show web inspector.
App building overview
From a high level, app building follows these steps.
1. Get started:
- What is your use case and how do you want to solve it?
- Decide what data you want to work with and how you're going to get it into Splunk.
- Storyboard your app so you know who will use it and how they'll navigate around.
2. Create your app workspace:
- Use app builder to create your app workspace.
- A more in-depth description of this step is located in this manual as Step 2: Create your app.
3. Add configurations to your app:
- Add custom configurations to index and process your data.
- App configurations include data inputs, indexes, users and roles.
- A more in-depth description of this step is located in this manual as Step 3: Add configurations.
4. Create objects for your app:
- Add saved searches and reports that display the information you're interested in.
- Add dashboards and other views, and put your saved searches and reports in your dashboards.
- A more in-depth description of this step is located in this manual as Step 4: Add Objects.
5. Set access controls and permissions for your app users:
- Set permissions to allow your app users to add knowledge objects to your app.
- Learn more about how object permissions work.
- Optionally add users and roles for your app. Create a role for the users you want to access your app.
- For example, if you're building an app for your web developer team, create a role called "Web_Developer" and add all your users into this role.
- A more in-depth description of this step is located in this manual as Step 5: Set permissions.
- Read more about how to create roles in Securing Splunk.
6. Build navigation
- Build navigation for your app so users can easily navigate to dashboards, reports, saved searches and other views.
- A more in-depth description of this step is located in this manual as Step 6: Build a navigation for your app.
7. Optionally add a setup screen for your app.
- If your app requires user input to be configured, add a setup screen.
- See examples of how to do this in Step 7: Configure a setup screen.
8. Optionally package your app for distribution on Splunkbase.
Apps and add-ons: an introduction
Step 2: Create your app
This documentation applies to the following versions of Splunk® Enterprise: 5.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4, 5.0.5, 5.0.6, 5.0.7, 5.0.8, 5.0.9, 5.0.10, 5.0.11, 5.0.12, 5.0.13, 5.0.14, 5.0.15, 5.0.16, 5.0.17, 5.0.18