Dashboard overview
Create new dashboards or edit existing ones.
For a quick glance at the most common use cases and commands for creating dashboards, note that you can access the Splunk Dashboards Quick Reference guide by clicking the link in Getting started.
The dashboard and form workflow
Working with dashboards includes one or more of the following tasks.
Build dashboards
- Create a new dashboard
- Add new visualizations to a dashboard
For more information on building dashboards, see Create a dashboard
Edit dashboards
- Add a panel to a dashboard
- Edit dashboard panels and panel visualizations
- Manage dashboard searches
For more information on editing dashboards, see Edit dashboards
Convert a dashboard to a form
- Add user inputs to a dashboard to convert it to a form
- Edit forms
- Work with user input settings
For more information on forms, see Create and edit forms
Customize Simple XML
- Edit Simple XML source code to customize a dashboard or form.
For more information on using Simple XML, see Editing Simple XML
Add interactive and dynamic behavior
- Use tokens to capture and transfer data.
- Add event handlers to implement dynamic behavior.
For more information on event handlers and tokens, see Use drilldown for dashboard interactivity and Token usage in dashboards
Tools and frameworks
To build and edit dashboards, use one or more of the following tools and frameworks.
Dashboard editor user interface
Build and edit dashboards using the Splunk Web user interface.
Simple XML
Dashboards use Simple XML source code to define their content and behavior. You can use the dashboard editor in Splunk Web to edit this source code.
To learn more, see Editing Simple XML.
Developer options
Splunk Enterprise users can implement additional dashboard customizations.
- Extend Simple XML using CSS and JavaScript.
- Convert a Simple XML dashboard to HTML and use JavaScript to implement customizations including inputs and REST API access.
For more information, see the following Splunk developer portal resources.
- Convert Simple XML dashboards to HTML
- Modify dashboards using Simple XML
- About SplunkJS stack
- Web Framework overview
Dashboards converted to HTML have some editing limitations in Splunk Web. They also cannot be exported to PDF.
Examples
The Dashboard Examples app on Splunkbase provides many dashboard implementation examples, including source code. Install the app to view and interact with the example dashboards.
Deprecated options
The following dashboard framework options are deprecated as of version 6.3.0.
Option | For more information see |
---|---|
Advanced XML | Advanced XML deprecation |
Module System (Deprecated as part of Advanced XML). | Advanced XML deprecation |
Django Bindings | Django Bindings Deprecation Notice |
Use trellis layout to split visualizations | About the dashboard editor |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10
Feedback submitted, thanks!