Use cases for this manual
Here's an overview of the topics in this manual and why you'd want to use them.
A dashboard is a view within Splunk Web that allows you to customize the visualization of data returned from searches. Using Splunk access control features, you can specify permissions to target specific dashboards for specific users.
You can create simple dashboards interactively from the editing tools available with Splunk Web. For details on using the Splunk Dashboard Editor, Search Editor, and Visualization Editor, see "Create and edit simple dashboards" and "Edit dashboard panel visualizations" in the Splunk User Manual. You can add additional functionality to a dashboard by editing the XML upon which the dashboard is configured. This manual shows how to create and edit dashboards by editing the XML upon which a dashboard is based.
A form is a view within Splunk Web that guides a user to enter specific data for a search. You can think of a form as a simplified version of Splunk's default search interface. Forms can contain multiple text inputs, drop-down menus, and radio buttons that specify the search. You can use forms to hide search terms that a user doesn't need to see, thus simplifying the user interface.
For example, consider a helpdesk team that always searches for serial numbers in a specific index on a given host. You can present a simplified interface that searches for a serial number selected from a drop-down list within a timeframe also selected from drop-down lists.
You cannot create forms from the Splunk interactive dashboard editing tools. This manual shows how to create and edit the XML code that implements forms.
Build advanced views
Splunk's uses its own Simplified XML syntax to create basic dashboards, views, and forms. Simplified 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 start out with Simplified XML syntax for dashboards, forms, and views, and then convert them to 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 apps in third party software. Refer to Overview of the Splunk SDKs at the Splunk Developer Portal for information on creating apps 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
Dashboards: An introduction
This documentation applies to the following versions of Splunk® Enterprise: 4.3, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7