Splunk | Example dashboard

Import and modify a ready made Splunk dashboard that will work in combination with the Quantum Splunk project.

Follow the below steps to import the two dashboards, which can be used with the Quantum Splunk project found here.

Important: This document includes references to a third-party product, Splunk. The user interface and usage of third-party products are subject to change without notice. For the latest published information about Splunk, see https://docs.splunk.com/Documentation.

Configure the XML files

  1. Click Search & Reporting

  2. Click Dashboards

  3. Click Create New Dashboard button.

    • Fill in title exactly as seen in the below screen shot "Perfecto Monitoring Example". The ID field will automatically populate and show match the below ID "perfecto_monitoring_example".The id field is what will be used to link from one dashboard to another so to ensure the example Dashboard works without modification you'll need to leave this in tact.
    • Optionally fill in a description and choose the Shared in App button.

  4. After clicking the Create Dashboard button, a blank dashboard will open. Click the Source button to open the Splunk XML editor. 

  5. Copy the XML source code from the Perfecto-Splunk-Home-Dashboard.xml file below

    Perfecto-Splunk-Home-Dashboard.xml

  6. Replace the existing lines of code in the XML editor and replace it with the copied code from the XML file

  7. On line 2, Change "Perfecto Monitoring Example" to "Your Company Name Monitoring Example" or use whatever name is fit.

  8. Click Save

  9. 9. Repeat Steps 1-7 for the below XML file - ensuring the create new dashboard dialog looks like the screen shot - title "Perfecto Availability and Performance Example" and id "perfecto_availability_and_performance_example"

     Perfecto-Splunk-Drilldown-Dashboard.xml

  10. Click the splunk icon in top left corner of screen

  11. Click the area the says "Choose a home dashboard"

  12. Type "Perfecto Monitoring Example" in the search box and click Save

  13. You should now see your Dashboard on the home screen

XML source overview 

First Label Node Sets the Title for the Dashboard
Fieldset Nodes Set dashboard filters - 
*To hide filters, add depends=”$hidden$” to the input node.
TimePicker Sets time filter
Timespan Sets time units for metrics 
For example: 10min, 30min, 1h, 2h, 4h, 1day
Device Sets filter for device model. Uses Primary.device field or the Secondary.device field
Status Sets filter for Pass or Fail. Uses Primary.testStatus, Secondary.testStatus, Primary.performanceStatus, or Secondary.performanceStatus.
Platform Sets filter for device platform. Uses Primary.os, Secondary.os
Dashboard Rows 
Panel  A container for a visualization i.e. Table, Chart, map, etc
Table

Title

Title for the visualization
Search Sets parameters for data to be viewed
Query The splunk search, including filter tokens
Earliest  For setting beginning of time period via the TimePicker fieldset
Latest  For setting end of time period via the TimePicker fieldset

Option

For setting various visual options for the visualization
Format Indicates a particular field for an option parameter.
ColorPallette A node with which the color of an element can be set based on data values

Drilldown


Link

Sets the url for a drill-down link, internal or external to the Splunk system.
For a link to a specific device in the Continuous Quality Lab use this xml on the “Link to Primary Device” field, changing 'company' to the name in the url. https://'company'.perfectomobile.com/nexperience/main.jsp?applicationName=Interactive&id=$click.value2|n$