3. Expand Your Splunk Apps Using Simple XML | Learning Splunk Web Framework

Sign In Start Free Trial

Book Overview & Buying
Table Of Contents

Learning Splunk Web Framework

By : Sesto

4 (2)

Learning Splunk Web Framework

4 (2)

By: Sesto

Overview of this book

Building rich applications on the Web using Splunk is now simpler than ever before with the Splunk Web Framework. It empowers developers to build their own web applications with custom dashboards, tables, charts, form searches, and other functionalities in the datasets at their disposal. The book will start with the fundamentals of the Splunk Web Framework, teaching you the secrets of building interesting and user-friendly applications. In the first application, you will learn to analyze and monitor traffic hitting the NASA website and learn to create dashboards for it. You will then learn additional, and more detailed, techniques to enhance the functionalities of the app such as dashboards and forms, editing simple XML, using simple XML extensions, tokens, post-process searches, dynamic drill-downs, the Splunk Web Framework and REST API, and much more. The second app will use historical stock market data and will create custom dashboards using Splunk Web Framework; the book will now cover important topics such as creating HTML dashboards, enhancing the visual appeal of the app using CSS, and moving your app with SplunkJS. The book will provide different and interesting examples instead of the usual “Log, Index, Search, and Graph” so that Splunk will be the first tool readers think of to resolve a problem.

Preface

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Free Chapter

1. Splunk Web Framework Fundamentals

1. Splunk Web Framework Fundamentals

Introducing the Splunk Web Framework

The development process and development environment

Introducing the example projects

Summary

2. Presenting Data to Users as a Splunk App

2. Presenting Data to Users as a Splunk App

Managing and creating your apps

Summary

3. Expand Your Splunk Apps Using Simple XML

3. Expand Your Splunk Apps Using Simple XML

File precedence and caching

Getting started with the SimpleXML code

The Splunk code editor

Create development branches with Git

Adding charts to dashboards

The Simple XML of charts

Expanding our Splunk app with maps

Finally, a table!

Completing your development and releasing to production

Summary

4. Layouts, Navigation, and Menus

4. Layouts, Navigation, and Menus

Setting your Splunk app's default page

Manipulating the menu structure

Biological cell simulation app

Manipulating your dashboard layout

Customizing layouts with JavaScript

Color-coding values in our display

Adding CSS into Simple XML

Summary

5. Interacting with Your User While Speeding up App Searches

5. Interacting with Your User While Speeding up App Searches

Speeding up data delivery with post processing searches

Using scheduled reports in dashboards

Splunk forms

More advanced form examples

Packaging up our Splunk apps

Summary

6. Moving from Simple XML to HTML

6. Moving from Simple XML to HTML

Moving forward by taking a step back

Converting your Simple XML code to HTML

The Splunk HTML Code Editor

Stepping through the HTML dashboard code

Why convert to HTML?

Making changes to HTML dashboards

Creating a Splunk App template

Summary

7. JavaScript Modules in Your HTML App

7. JavaScript Modules in Your HTML App

JavaSript modules in the Splunk Web Framework

Adding animation to Splunk dashboards

Ensuring your code is correct

Customizing JavaScript Modules in HTML

Implementing external libraries in your HTML code

Adding your icon to your Splunk App

Summary

8. Utilizing CSS to Spice Up Visual Appeal

8. Utilizing CSS to Spice Up Visual Appeal

CSS templates and themes

Get the raw dashboard ready

Implementing your own CSS style

Inline style sheets

Using internal style sheets in your Splunkcode

CSS and dashboard menus

Setting up external style sheets in Splunkapps

Using the Splunk Web Framework CSS

Bootstrap alerts in your Splunkdashboard

Bootstrap and dashboard headings

Bootstrap tool tips

Losing our Bootstrap themes

Summary

9. Moving Your App off Splunk with Splunk JS

9. Moving Your App off Splunk with Splunk JS

So what is SplunkJS?

What about the Splunk SDK?

Host Splunk data outside of Splunk

Setting up our website

Interacting with Splunk through the management port

Let's get started with SplunkJS

So what if your test page doesn't work?

Let's create our new web page...mobile first

Authenticating with your Splunkenvironment

Automated testing of our web page

Writing a simple test

Considerations when testing

Summary

Getting started with the SimpleXML code

We are going to dive straight in and create another dashboard with one chart. We will create it using the Splunk web interface and then be able to view the underlying code that is created as SimpleXML:

Let's start by accessing our NASA squid and web data app and click on the Dashboards menu.
We want to create a new dashboard for this exercise, so we click on the Create New Dashboard button.
Set the Title as SimpleXMLDashboard and click on the Create Dashboard button.

In this example, we want to search for all the requests that have been made to the NASA website for movies from educational domains, using the following as our search:

index=main sourcetype=NASASquidLogs | search movies | search edu | top 5 From

From within your new SimpleXMLDashboard:

Click on Edit and select Edit Panels.
Click on the Add Panel button and select New, and then choose Bar for a bar chart.
Set the details of the chart to the following values:
- Content Title: Education Usage
- Search...

Visually different images

CONTINUE READING

83

Tech Concepts

36

Programming languages

73

Tech Tools

Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.

Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.

50+ new titles added per month and exclusive early access to books as they are being written.

Learning Splunk Web Framework

Search

Your notes and bookmarks