Overview of creating an app

To get started developing an app or add-on for Splunk Enterprise or Splunk Cloud, you'll need:

  • A Splunk Enterprise test environment.
    Use an installation of Splunk Enterprise on a single-instance development environment, such as a laptop. For more about supported computing environments, see System requirements for use of Splunk Enterprise on-premises in the Installation Manual.
  • Development tools.
    Splunk Web has a built-in source code editor with syntax highlighting and auto-indent features, or use your own editor for XML, CSS, and HTML files. You can also use debugging tools that are included with web browsers.
  • A plan for your app.
    Determine the scope of your app and decide on the use case you want to address. Storyboard your app and create mockups of the dashboards, panels, and navigation.
  • Sample data.
    Decide what data you want to work with and how you're going to import it. Get some sample data to test your app.

The basic process for developing a Splunk app is as follows:

  1. Create an app using Splunk Web. See Create a Splunk app for details.
  2. Configure app properties, such as the app configuration settings and static assets. See Configure app properties for details.
  3. Get data into Splunk using data inputs, indexes, and modular inputs. See Configure the data layer for details.
  4. Search your data using the Splunk search language and optimize your searches (filter, limit scope, avoid real-time searches). For more, read the Search Manual.
  5. Enrich the search with Splunk knowledge objects such as saved searches, event types, transactions, tags, field extractions, transforms, lookups, search commands, and data models. See Configure knowledge objects for details.
  6. Set permissions for the objects in your app to specify what users can see (read) and interact with (write). See Set permissions for objects in a Splunk app for details.
  7. Create alerts using both out-of-the-box alert actions, as well as custom alert actions to integrate with other systems. For more, read the Alerting Manual.

Next steps

Continue developing your app by adding visualizations, navigation, and more. See Develop an app or add-on.

When you are ready to package, inspect, certify, and publish your app, see Release an app or add-on.