Splunk® Enterprise

Developing Views and Apps for Splunk Web

Download manual as PDF

Splunk Enterprise version 6.x is no longer supported as of October 23, 2019. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Use cases for this manual

Here's an overview of the topics in this manual and why you'd want to use them.

Build advanced views

Splunk Enterprise uses its own simple XML syntax to create basic dashboards, views, and forms. Simple XML is a layer that sits on top of an advanced XML implementation. Many advanced features in views are based on modules that require advanced XML syntax. The Splunk Module Reference lists all modules available for building advanced views.

This manual describes how to build dashboards, forms, and views using advanced XML syntax to implement the more advanced features. It discusses some of the most commonly used modules with examples.

Customize Splunk Web

There are many ways to customize views in Splunk Web. This manual discusses:

  • Customizing the Splunk Web login screen
  • Customizing event display using HTML and JavaScript
  • Using CSS to customize the look of a view or app
  • Localizing text using GetText technology

For more information about extending and creating Splunk Enterprise modules, see the Module System User Manual.

Build apps

A Splunk Enterprise app is a collection of configurations, objects, and knowledge built within Splunk's app framework. A user installs an app either from a file or directly from Splunkbase (assuming the app has been made available from Splunkbase by the app author).

Splunk Web provides App Builder, which you can use to create apps that are based on Splunk app templates. This manual walks you through creating an app using App Builder. It also shows you how to prepare your app for uploading to Splunkbase.

Splunk also provides SDKs which you can use to create applications in third party software. Refer to Overview of the Splunk SDKs at the Splunk Developer Portal for information on creating applications using the Splunk SDKs.

Build scripted inputs

You can use scripts to feed data to Splunk Enterprise for indexing, or to prepare data from a non-standard source to properly parse events and extract fields.

This manual shows how you can set up and write reliable scripts to input data.

Extend Splunk Enterprise using the REST API and Splunk SDKs

Splunk provides a REST API that provides access to Splunk from other applications. Any application that can make an HTTP request can configure and manage a Splunk instance, and also create and run searches and access the results returned.

Splunk provides various SDKs that use the REST API for access to a Splunk Enterprise instance. This lets developers access to a Splunk instance using a programming language familiar to them. Refer to Overview of the Splunk SDKs at the Splunk Developer Portal for details on using the Splunk SDKs.

The REST API Reference Manual lists all publicly available endpoints with examples of return values.

What's in this manual
About advanced XML

This documentation applies to the following versions of Splunk® Enterprise: 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8, 6.2.9, 6.2.10, 6.2.11, 6.2.12, 6.2.13, 6.2.14, 6.2.15

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters