If you’re new to the Splunk Dashboards app (beta) on Splunkbase and you’re trying to get started with building beautiful dashboards, this blog series is a great place to start. The Splunk Dashboards app (beta) brings a new dashboard framework, intended to combine the best of Simple XML and Glass Tables, and provides a friendlier experience for creating and editing dashboards. Read more about this new dashboarding framework, or catch up on previous posts in this blog series about custom SVG choropleth maps, using Grid layout and Saved Searches, and using dashboard defaults for visualizations.
This post will cover the new Examples Hub in the app, how to edit a visualization or data source’s source code in the UI, and updates to dashboard inputs. For notes on every feature, see the release notes on Splunkbase.
View sample dashboards for v0.8 (and previous releases) on the Splunk Dashboards Beta Examples GitHub. Bonus! You can also download free dashboard backgrounds from GitHub.
Whether you’ve been using the Splunk Dashboards app (beta) for months or are just getting started, you may have found yourself thinking “gee, I wish there were some examples I could look at, to use as a starting point.” Well, look no further! The Splunk Dashboards app (beta) v0.8 comes equipped with a multitude of examples for visualizations, data source types, inputs, dashboard defaults, and complete dashboards.
To get started, find the “Examples” menu option in the Splunk Dashboards app (beta), then explore the topic you are interested in. Each example also comes equipped with the source code, so you can double click to select, then ctrl-C to copy it into your own dashboard to edit and use!
Edit Visualization or Data Source IDs in the UI
You know it, we know it, it is not easy to rename the unique ID for the visualization and data source in all the right places in source code. With the Splunk Dashboards app (beta) v0.8, you can now view and edit the ID and source code for a selected visualization or data source in the UI. Look for the “Code” section in your right side editor panel.
Global Time Range Input
Splunk Dashboards app (beta) v0.8 comes with a handful of updates for inputs. First up: all new dashboards will automatically have a global time range picker input included. This means all your data sources will automatically be wired up to this time range picker, unless you choose to override that for a specific data source. In the source code of a new dashboard, you’ll see that the inputs, layout, and defaults stanzas are updated to include the global time range picker.
Add and Delete Inputs from the Editor UI & New Number Input
Gone are the days when you had to add an input via source code! In the editor UI, you can now add inputs to your dashboard from a dropdown menu in the toolbar. You’ll also notice the option to add a new input type: a Number input. This allows you to ensure a dashboard consumer can only enter a numeric value. You can also remove inputs directly from the canvas.
UI Editors for Single Value Font Sizes
Continuing with the new UI theme, the Splunk Dashboards app (beta) v0.8 also comes with UI editors for single value major and delta font sizes. You can now customize the font sizes and immediately see the visualization update, rather than going back and forth between the UI editor and source code editor.
Using Tokens with Base/Chain & Saved Searches
Using tokens in base and chain (post process) searches is a critical piece of functionality, so here is an example of how to do so. This example dashboard is also available for download from the Splunk Dashboards Beta Examples GitHub.
This example will use an input to drive a token that is then passed into a tree of base and chain searches. More information is available in the base and chain documentation.
To do this, you must first define the input and its token in the inputs stanza. Don’t forget to specify it in the globalInputs section of the layouts stanza to ensure it displays on your dashboard. In this example, the input is “input0”.
Then, make sure to reference this token when authoring your queries. The source code snippet below shows the base search and one of the chain searches. In the chain search’s query, you can see that it is only a partial query, because it is an extension of the base search, which is referenced by the extend option. You can also use ds.savedsearch as a base search. The token, which was defined in the inputs stanza, is demarcated in the query by the dollar symbol $ on each side.
Any time a token is updated, it changes the query, and therefore will refresh the entire base and chain tree. For more information about best practices, visit the documentation.
- Enhanced UI controls for inputs
- Expanded visualization thresholding options & refreshed UI controls
*This information is subject to change at any time, at the sole discretion of Splunk Inc. and without notice. This roadmap information shall not be incorporated into any contract or other commitment. Splunk undertakes no obligation to either develop or deliver any product, features, or functionality described here.