Splunk® Enterprise

Module System User Manual

Download manual as PDF

Download topic as PDF


Important notice: As part of Advanced XML deprecation, the Module System is officially deprecated beginning with Splunk Enterprise 6.3. For more information, see Advanced XML Deprecation.

A - C - D - H - J - M - X



Asynchronous JavaScript and XML

See: http://en.wikipedia.org/wiki/Ajax_(programming)

Module client code uses AJAX to make GET requests on server endpoints. Modules usually override the Splunk.Module base class getResults() method to request and handle search results. Most often, the data returned in the response is in JSON format.



Cross-site request forgery

See: http://en.wikipedia.org/wiki/CSRF

It is important to guarantee that POST requests are authentic to protect against CSRF attacks. The Module System provides the csrf_hidden_input() template utility to insert a hidden form used to verify the validity of the POST request.


Cascading Style Sheets

See: http://en.wikipedia.org/wiki/Css

Default style sheets are located at $SPLUNK_HOME/share/splunk/search_mrsparkle/exposed/css/ and $SPLUNK_HOME/share/splunk/search_mrsparkle/exposed/css/skins. You can do simple app customizations using custom style sheets.



Document Object Model

See: http://en.wikipedia.org/wiki/Document_Object_Model

As in common web programming, DOM is mostly used for binding handlers to DOM elements; preferably, using the jQuery $(document).ready(function() {...}); method. A number of Module System APIs also provide access to DOM properties.



HyperText Markup Language

See: http://en.wikipedia.org/wiki/Html

Mako templates implement the app view component of the [MVC MVC ] pattern using HTML and Python-like constructs.


Hypertext Transfer Protocol

See: http://en.wikipedia.org/wiki/Http

Module System uses CherryPy to implement the HTTP server.



JavaScript Object Notation

See: http://en.wikipedia.org/wiki/Json

The JSON data format is one of the formats supported for transferring data from the server to client. See render_json(). JSON is most often the format of the data returned in a module AJAX request.




See: http://en.wikipedia.org/wiki/Model_view_controller

The Module System implements the MVC architecture pattern for functions that do not involve search, jobs, results, or events. See the Set up your app recipe in the Cookbook.




See: http://en.wikipedia.org/wiki/XMLHttpRequest

Code and documentation occasionally use XHR to refer to an HTTP request.


Extensible Markup Language

See: http://en.wikipedia.org/wiki/Xml

App view layout and navigation are specified using XML notation. Building apps using Module System mostly involves using Advanced XML to describe your app view.

Module system terminology
Module Reference

This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.2.0

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