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's 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
- Embedding Splunk dashboard elements into a Web application using IFrame
- Using CSS to customize the look of a view or app
- Localizing text using GetText technology
The Splunk Developer Portal provides additional information on extending and creating Splunk modules.
A Splunk 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 for indexing, or to prepare data from a non-standard source so Splunk can properly parse events and extract fields.
This manual shows how you can set up and write reliable scripts to input data.
Extend Splunk 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 instance. This allows 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.
What's in this manual
About advanced XML
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