Customize your app's look and feel

Customize your app's look and feel

Splunk's UI -- Splunk Web -- is completely customizable. Change the layout of a page. Change the contents within a page. Change the colors of items within the page, add your own custom logo, rearrange the drop-down menus and customize how events are displayed. You can even add in your own HTML, JavaScript and CSS. You can customize Splunk Web the same way you'd customize any website.

View system

Splunk's view system sets what is displayed on a page, and also page layout. Maybe you want to add a search bar, or a chart. Use Splunk's view system to customize your page layout.

Every page in Splunk Web is custom built. These pages, or views, are XML files stored in an app's view directory. Views are made out of a library of modules. Every module is actually a directory of CSS, JavaScript, HTML and, in some cases, Python and Flash.

If you're just starting out with Splunk's view system, start with the simple view building section. The simple view syntax is built on top of the advanced syntax and abstracts away a lot of the configuration options. Read more about building simple views. If you're comfortable with Splunk's view system, or you want to dive right into the XML structure, you can read about building advanced views.

There are three main types of views: dashboards, form searches and search views. Each type of view is defined by a Mako template, located in $SPLUNK_HOME/share/splunk/search_mrsparkle/templates/view/. Mako templates are HTML files with support for Python. Splunk's templates define page layout; basically, how each element fits into a page.

Dashboards

Dashboards are useful for presenting visual summaries of various searches and reports. You can build dashboards with the simple dashboard builder, the simplified XML and the advanced XML. Learn more about dashboards here.

Form searches

Form searches let you restrict the search interface to present one or more search boxes with more complex searches running behind the scenes. You can build form searches with simplified XML or advanced XML. Read more about form searches here.

Search views

Search views are pages that let you run a search and interact with search results, like the flash timeline view. Search views can only be built in the advanced XML. Learn more about how to build a search view here.

Customization options

In addition to changing page layout, you can also customize other aspects of Splunk Web. You have the same options you'd have for customizing any website -- change the style via CSS, add an IFrame to a third party application, change navigation, etc.

Here's a descriptive list of your options for customizing Splunk Web, with links into the relevant documentation:

• Build your own drop-down menus.
  • Set up custom drop-down menus in Splunk Web. You can set up rules to group together similar dashboards, search views, saved searches and reports.
  • Learn more about how to customize navigation menus.
• Use IFrames to embed a third party web resources into your App.
  • Learn more about how to add third party web resources to your App.
• Add custom HTML to your app.
  • Create a custom web page to add into your app. Splunk's webserver will serve up any HTML, JavaScript, CSS, Python or other code you add into your App's directory.
  • Learn more about how to add custom HTML to your App.
• Set a style for your app.
  • Use CSS to change the colors, borders, gradients and other display options for your app.
  • Learn more about how to change your app's style.
• Customize how your events display.
  • Add decorations to your events to call out the presence of a specific field.
  • Learn more about how to build a custom event renderer.
• Set custom charting options.
  • If you've added a chart to your dashboard or report, you can customize how it's displayed by setting custom charting options. Change the colors, the axes, and the scale. Add a legend.
  • Learn more about how to customize charts.

• Was this topic useful?
• Post a comment