Use the Splunk Web Framework

The Splunk Web Framework provides tools for you to develop dashboards and visualizations for Splunk apps. Splunk's extensible markup language, Simple XML, is the underlying source code for the dashboards created using the built-in Dashboard Editor. For more about working with the Dashboard Editor and Simple XML, see the Dashboards and Visualizations manual in the Splunk Enterprise documentation.

If you are a developer who wants to further customize dashboards and apps in a familiar web developer environment to programmatically interact with Splunk, use these tools that work with SplunkJS Stack. SplunkJS Stack is the web stack of JavaScript and JavaScript libraries that contains prebuilt components for searches and visualizations.

  • Simple XML extensions
  • Use extensions to modify the appearance and behavior of a dashboard. Extensions are CSS and JavaScript files that you add to your app then reference from the dashboard's Simple XML code.

  • HTML dashboards
  • For full control over the appearance and behavior of an app, convert any dashboard from Simple XML to HTML, which lets you start with autogenerated code that you can modify. Use your favorite development tools to work with CSS, HTML, and JavaScript code to build rich, interactive experiences.

Learn more about these key features to develop custom Splunk apps and dashboards:

  • Search managers correspond to your Splunk search jobs, saved reports, and post-process searches.
  • Splunk views correspond to Simple XML visualizations, and are used to visualize data, accept form input, and control searches.
  • Bind data using tokens provides a handy mechanism for you to bind values together from searches and views to keep them in sync.
  • Drilldown actions let you customize the drilldown behavior when users click on views.
  • App key value store lets you save the state of your app and other app-specific data.
  • Splunk dashboard styles are used by HTML dashboards for layout.
  • Navigation lets you add links and menus to your app's navigation bar.
  • Packaging and publishing your app lets you deploy and distribute it.