SplunkJS Stack

The Splunk Web Framework includes a SplunkJS Stack component for web developers who want to create Splunk apps in a familiar JavaScript environment. This web stack includes a number of tools to help you create Splunk apps:

  • Libraries for Splunk views and search managers for working with searches and interacting with Splunk data.
  • Backbone.js provides an MVC framework as a structure for your code.
  • RequireJS manages dependencies.
  • jQuery helps manage the document object model (DOM).

So using SplunkJS Stack along with your favorite development tools, you can build rich interactive apps to access and manipulate Splunk data. You can also add third-party visualizations to your apps, as well as create your own reusable views.

Create Web Framework apps for Splunk Web

Use SplunkJS Stack to develop Splunk Web apps, which are apps that appear in Splunk Web, relying on Splunk's app server to interact with splunkd and Django's template system to render data into HTML pages. And using Splunk's built-in navigation bars, headers, and footers, you can give your apps the same look and feel as Splunk.

To get started quickly with SplunkJS Stack to create Splunk Web apps:

  1. Create a Web Framework app
  2. Create a page template for your app
  3. Add a search manager to a template
  4. Add a Splunk view to a template

If you want to dive right in and create an app with third-party visualizations, see the Tutorial: Create a music dashboard. For examples of page templates that use JavaScript, see the end-to-end code examples.

Add SplunkJS Stack to your own web apps

Add the SplunkJS Stack libraries to your own web apps to use the Web Framework search managers and views to interact with Splunk and display data. Download SplunkJS Stack here.

To learn more, see the following topics:

For a step-by-step process, see How to add Splunk to your own web apps using SplunkJS Stack. Or, jump right in and see the code examples.