App Framework Cookbook

Introduction

This cookbook presents fundamental App Framework concepts and features, by way of example, to give you the practical knowledge needed to begin creating more sophisticated applications for your domain. The examples, or recipes, include:

Details

We take a simple application, CPU resource utilization, and iterate on that example, building on what you already know toward gaining a more complete understanding of the App Framework. The metrics.log data source we use is readily available.

Look at the Example1 code to see how this app might be implemented using existing Splunk components. We use a SimpleResultsTable module and the following search command to render a table of CPU utilization statistics. 

index=_internal source=*metrics.log group=pipeline |
      stats sum(cpu_seconds) as totalCPU by name

Customizing different application views, we demonstrate particular framework features. With each example recipe, we show the points-of-extension that enable you to hook into the framework when implementing your own custom, domain-specific app. You gain a large degree of reuse, typically through sub-classing, by building on the core framework module, AJAX, and MVC technologies.

 

The approach we take is similar to the UI Example app, where you can run and view the app code while reading the tutorial. It is helpful to install and review the Advanced XML part of the UI Example app as a starting point for understanding App Framework app structure. Other resources for getting started include: