Splunk® Enterprise

Module System User Manual

Acrobat logo Download manual as PDF


Splunk Enterprise version 7.1 is no longer supported as of October 31, 2020. 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® Enterprise. For documentation on the most recent version, go to the latest release.
Acrobat logo Download topic as PDF

Welcome

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.

The Module System exposes the core Splunk knowledge base for the purpose of building custom app customized for your application domain. A framework is inherently complex and requires suitable documentation and examples to be able to use it effectively. Here, you'll find documentation that covers the key concepts and reference material needed to begin creating apps.

You'll find this documentation to be applicable to different phases of the development lifecycle and different levels of expertise. For example, Getting Started is most useful for initial familiarization with the framework and development process, while the reference API might be consulted frequently to refresh your memory about programming details. Because examples and learn-by-doing provide the most effective techniques for learning complex topics, an example accompanies most discussion. In particular, the Cookbook includes a complete set of examples, in the menu above, that you can actually run in the context of this app.

Become familiar with terminology. If you are new to Module System development, read Getting Started. Consult the Cookbook and its associated examples to learn how to implement common use cases. You'll find the implementation details in the Reference useful after you've learned the basics of how to develop in the Module System environment.

The documentation set provides the various system views a developer needs to understand and use the Module System.

Last modified on 12 August, 2019
  NEXT
Module system terminology

This documentation applies to the following versions of Splunk® Enterprise: 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.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9


Was this documentation topic helpful?


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