Book Image

Learning Splunk Web Framework

By : Vincent Sesto
Book Image

Learning Splunk Web Framework

By: Vincent 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.

Related Content you might be interested in

Current Title:

Small book image
Learning Splunk Web Framework
Vincent Sesto
Aug, 2016 | 262 pages
No titles found
Table of Contents (15 chapters)
Learning Splunk Web Framework
Learning Splunk Web Framework
Credits
Credits
About the Author
About the Author
About the Reviewer
About the Reviewer
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Splunk Web Framework Fundamentals
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
Presenting Data to Users as a Splunk App
Managing and creating your apps
Summary
3
Expand Your Splunk Apps Using Simple XML
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
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
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
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
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
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
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

Authenticating with your Splunkenvironment

Our code so far looks very similar to the code from the HTML dashboard that we have been working on in the previous chapters. One major difference that you need to note is that we need to set up authentication with our Splunk environment to allow communication to take place. In our previous chapters, this was not an issue as we were using our Splunk environment as our development platform, but now when we move our web pages off Splunk, this needs to be taken into consideration.

This is one of the great features of SplunkJS. By using the config.js JavaScript file, it allows us to easily authenticate without the need for any complicated coding. It's now time to implement our authentication as part of our website, so let's continue with our coding:

  1. We should already have our company_site.html file open and we can start by moving down to the bottom of the file, where we will start to add the JavaScript section of our code:

          64 <!-- JavaScript section...
Previous Section
End of Section 10
Next Section