Splunk Developer's Guide

Kyle Smith

• Verlag: Packt Publishing
• Jahr: 2015
• ISBN:
  9781785285295
• Thema: Ciencia de la computación
• Thema: Desarrollo de aplicaciones

Splunk Developer's Guide

---

Table of Contents

Splunk Developer's Guide

Credits

About the Author

About the Reviewers

www.PacktPub.com

Support files, eBooks, discount offers, and more

Why subscribe?

Free access for Packt account holders

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Downloading the example code

Errata

Piracy

Questions

1. Application Design Fundamentals

Overview of what this book isn't

What this book is

Assumptions

What is a Splunk application?

Why applications?

Definitions

Designing the App

Identifying the use case

Identifying what you want to consume

Identifying what you want to brand

Identifying what you want to display

App installation

Splunk Web

The Splunk command line

Unzipping via the command line

Summary

2. Creating Applications

Point of order

Methods of creating applications

GUI

CLI

FreeForm

Basic structures

The appserver folder

The bin folder

The default folder

The local folder

The lookups folder

The metadata folder

The static folder

Application data

Indexes

Source types

Sources

Available Splunk knowledge objects

Macros

Event types

Tags

Saved searches

Dashboards

Lookups

Configurations

Object permissions

The setup screen

The endpoint

The setup file

Summary

3. Enhancing Applications

Workflows

Enriched data

Event types

Tags

Macros

Lookups

Common Information Model

Branding your App

Logos

Navigation

CSS

JavaScript

Acceleration

Summary indexing

Accelerated reports

Summary

4. Basic Views and Dashboards

Knowing your data

Modules available

SimpleXML dashboard

SimpleXML forms

HTML dashboards

Summary

5. The Splunk Web Framework

The HTML dashboard

The SplunkJS stack

Search-related modules

SearchManager

SavedSearchManager

PostProcessManager

View-related modules

ChartView

The different types of ChartView

Area

Bar

Column

Filler gauge

Line

Marker gauge

Pie Chart

Radial gauge

Scatter

Display-related modules

CheckboxView

CheckboxGroupView

DropdownView

EventsViewerView

FooterView

HeaderView

MultiDropdownView

RadioGroupView

SearchBarView

SearchControlsView

SimpleSplunkView

SingleView

SplunkMapView

TableView

TextInputView

TimeRangeView

TimelineView

Tokenization

Customizing Splunk dashboards using CSS

Customizing Splunk dashboards using JavaScript

Custom D3 visualization

External data and content

Data

Content

Summary

6. Advanced Integrations and Development

Modular D3 visualization

Modular inputs

The spec file

Testing modular inputs

Configuring modular inputs

The App Key Value Store

When would you use the KV Store?

Configuring the KV Store

Data models

Version control and package managers

NPM

Bower

Gulp

Git

Tying them all together

Summary

7. Packaging Applications

Naming guidelines

Do's and don'ts

Packaging the App

The App packaging checklist

Summary

8. Publishing Applications

Self-hosting your App

Splunkbase

Certified Applications

Community

Answers

dev.splunk.com

Internet Relay Chat

Wiki

User groups

Summary

Index

Splunk Developer's Guide

Copyright © 2015 Packt Publishing

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.

Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.

First published: May 2015

Production reference: 1250515

Published by Packt Publishing Ltd.

Livery Place

35 Livery Street

Birmingham B3 2PB, UK.

ISBN 978-1-78528-529-5

www.packtpub.com

Credits

Author

Kyle Smith

Reviewers

Dave Dyer

Dr. Rudy Deca

Dr. Benoit Hudzia

H Robert King

Commissioning Editor

Kartikey Pandey

Acquisition Editor

Vinay Argekar

Content Development Editor

Amey Varangaonkar

Technical Editors

Madhunikita Sunil Chindarkar

Manali Gonsalves

Taabish Khan

Copy Editors

Aditya Nair

Vikrant Phadke

Adithi Shetty

Project Coordinator

Nidhi Joshi

Proofreaders

Stephen Copestake

Safis Editing

Indexer

Hemangini Bari

Production Coordinator

Nitesh Thakur

Cover Work

Nitesh Thakur

About the Author

Kyle Smith is a self-proclaimed geek and has been working with Splunk extensively since 2010. He enjoys integrating Splunk with new sources of data and types of visualizations. He has spoken numerous times at the Splunk User Conference (most recently in 2014 on lesser-known search commands) and is an active contributor to the Splunk Answers community as well as on the #splunk IRC channel. He has published several Splunk Apps and add-ons to Splunk base, the Splunk community's premier Apps and add-ons publishing platform. He has worked in both higher education and the private industry, most recently as an infrastructure analyst at a Fortune 400 company. He lives in Central Pennsylvania with his family.

I'd like to thank my wife, who most graciously put up with all my tantrums during the writing of this book. Without her, this effort is meaningless.

About the Reviewers

Dave Dyer is a disrupter, an innovative thinker, and a deconstructor of assumptions. He vigorously evangelizes the benefits of applying scientific principles to difficult-to-solve problems (for instance, modern cybersecurity). He is a security veteran and became devoted to the power of data analysis while doing plasma physics research in the CU Boulder astrophysics program. Dave is currently a use case developer/Splunk engineer/security data nerd for a large healthcare organization. In his off time, he enjoys kiteboarding, long walks on the beach, talking about his feelings, and attempting to raise a decent human being (okay, only two of those are true).

Dr. Rudy Deca, is a resourceful goal-oriented problem-solver and technology user. He obtained a master's degree in computer science from Concordia University an...