Splunk UI and Dashboard Framework: More Visual Control Than Ever

If you’ve attended .conf21 or followed Lizzy Li’s Splunk blogs over the past year, you’ve probably heard of Splunk Dashboard Studio – our new integrated dashboard experience included in Splunk Enterprise 8.2 and later and Splunk Cloud Platform 8.1.2103 and above. With new, beautiful visualizations and the ability for greater visual control over the dashboard, our customers and Splunkers have created beautiful and insightful dashboards to turn data into action.

You may also have noticed that dashboards and visualizations inside Dashboard Studio look similar to visualizations inside other Splunk apps, such as Mission Control, Enterprise Security 7.0, and Glass Tables in Splunk IT Intelligence department. Indeed, all of these solutions use the same underlying visualizations and dashboard framework, which drive the user experience. Since .conf21, any Splunk application developer can embed the Splunk Dashboard framework and other visual Splunk UI components into their applications. In this blog post, we’ll explain what the Dashboard Framework is, how you can access it, and how it can help developers meet their advanced dashboard needs outside of Dashboard Studio and Dashboards. classics.

Dashboard Studio: built on our dashboard framework

Dashboard Studio is designed to provide an intuitive dashboard creation experience, allowing dashboard creators to have more control over the dashboards they create. The hope is that we can provide enough customization that most users won’t need custom development with JavaScript or CSS like they needed for advanced use cases in our classic dashboards. . With absolute layout and the tools to control branding (like color, icons, images, and SVGs), Dashboard Studio covers many use cases previously achieved with custom CSS or HTML extensions in dashboards. classic edges.

A dashboard designed for Splunk TV.

What about custom JavaScript in Dashboard Studio? We intend to support most common custom JavaScript use cases, such as opening tooltips or informative modals, including visualization from a third-party source and more by as built-in Studio features over time. However, we know that today app developers already want to build custom dashboards, including integrations with other tools and custom workflows. For users who still need to meet these requirements, directly developing and submitting custom feedback pages built with @splunk/create and the Splunk Dashboard Framework may be a better alternative to Dashboard Studio, and so we are here today to tell you more about it.

Get started with the dashboard frame

When you develop with Dashboard Framework and @splunk/create, you create a ReactJS app and import the tools that allow you to render dashboard and visualization components inside that app. This allows you, as a developer, to use these different packages to create custom pages inside your app that can act as Splunk dashboards and look like those created in Dashboard Studio. However, these custom pages can go beyond the current capabilities of dashboards created in Dashboard Studio by allowing you to create completely custom components and pages. The best way to get started is to check out our samples gallery, where we have tutorials that will help you get started with building a Splunk app and building a dashboard with custom functionality.

A custom modal interaction built with Splunk UI and Splunk Dashboard Framework

When should I use the Dashboard Framework?

When you need the latest visualization and dashboard framework features, now.

Developing an app with Dashboard Framework means you’ll be building on the latest and greatest dashboard and visualization packages used in products like Dashboard Studio, ITSI, and Splunk Enterprise Security. This allows you, as a developer, to provide a personalized experience with the latest dashboard and visualization features inside or outside of a version of Splunk Enterprise or Splunk Cloud Platform. This is especially useful for Splunk Enterprise customers whose development is limited by the release cycle of Splunk Enterprise or Splunk Cloud Platform.

When you have savvy React developers in your organization.

If you have savvy React developers in your organization and your organization wants to go beyond what Dashboard Studio offers today, then Dashboard Framework might be right for you. Many examples in our sample gallery show customizations built on top of our dashboard framework.

If you are ready to accept certain compromises.

It is important to note that one of the main disadvantages of direct development with Dashboard Framework is that the user interface and source editors for dashboards, as well as PDF and PNG export capability, are only available in Dashboard Studio dashboards. So if end-user control via editors and PNG/PDF export are important to your view, a Dashboard Studio dashboard would probably be better suited to your needs. If you want to trade this functionality for more complex interactions and custom functionality, consider developing your view with the Dashboard Framework.

Keep in mind that your custom app can contain a Dashboard Studio dashboard, a custom React page, and classic dashboards. So this is not a case where you have to choose one or the other. Whichever route you choose, we hope our suite of dashboard features can help you with the unique use cases that dashboard and app developers solve every day.

A custom sample built with the Splunk UI and Splunk Dashboard Framework.

Next steps and resources

If you think delivering dashboards with the Dashboard Framework is right for you, or if you think you want to try it yourself to assess the possibilities, check out the Splunk UI Toolkit Samples Gallery, which contains some examples of open source tools. applications developed with the dashboard framework. We are showing different use cases for the dashboard framework and are always looking for feedback on other use cases to include.


.conf21 Discussions around Splunk UI and Splunk Dashboard Framework:

This blog was co-authored with Nusair Haq, Product Manager for Splunk Web Platform Projects.

Comments are closed.