Give your users more powerful dashboards, and build them in half the time
This app provides key components and tools that make it easier and faster to develop custom Splunk dashboards and views. Most important are the Sideview UI modules, which offer improved functionality and easier configurability over the legacy core Splunk modules.
Additionally the app contains interfaces and tools including a visual authoring system you can use to create and edit Advanced XML dashboards.
Put simply, Sideview Utils takes most of the pain out of the “Advanced XML”.
Wait I thought the Advanced XML was going away?
You may have heard that Splunk deprecated the Advanced XML a while ago. Sideview Utils, although it has long ago circumvented or replaced most of the advanced XML code, does indeed still live on top of the Advanced XML. What has been happening over the last 2 years is that completely new systems have been written, with the idea being that your Sideview XML views, if authored according to reasonable practices as recommended in Sideview Utils, will live on even after Splunk turns off the “advanced XML”. Essentially this amounts to a new front end for Splunk, and the only integration point this UI has with SplunkWeb is that the HTML is served out of a custom python controller. At the moment this is in the form of an unreleased app called “Canary”. I can’t tell you very much beyond the fact that a) there is a working version, b) It is a great deal faster, and c) most likely we will migrate away from the old XML format into a new format that is much less deeply nested and easier to deal with.
What are the advantages of Sideview Utils / Canary over say SimpleXML and SplunkJS?
The considerable advantage of Sideview Utils is the same as it has always been – that if you read through the docs and examples, that you can dream up and implement very complex dashboards with rich interaction and drilldowns without having to know any programming language at all. You might say that this is the case with the Simple XML, but the problem with the Simple XML is that it long ago stopped being simple. And even with all the complexity that it has, it is still quite limited when you try and implement the idiosyncratic and odd UI needs that your business has given you.
You can read an old but still relevant writeup of this in this question on answers.splunk.com.
Documentation? How do I get started?
The app itself is full of walkthrough documentation and hundreds of living examples of the configurations being discussed. Start by downloading the Sideview Utils app and read the first 2 pages of overview documentation in the app itself.
How do I download and install it?
- Use the “Download Full Version” link over on the right.
- After you enter your email address and accept the license you’ll receive an email with a link you can use to download the app. Just save the file to your desktop for now.
- Log into the Splunk UI as an admin user and navigate in the Apps menu to “Manage Apps”.
- Click the button labeled “install app from file”.
- If you already have an older copy of the app installed, you will have to check the “upgrade app” checkbox.
- Specify the file you downloaded in the form, and click submit
- If you get a confusing error message, try again with the “upgrade app” checkbox checked.
Watch some videos
If you’re prefer, you can watch one of our little 10-minute overview videos first.
- Cooking with Sideview 5: the Pulldown Module
- Cooking with Sideview 4: Sideview Utils overview
- Cooking with Sideview 3: the Sideview Editor
- Cooking with Sideview 2: docs that live and breathe
- Cooking with Sideview 1: the Sideview report builder
If you’re not already on it, get on our mailing list to get notified when there are new releases.