Splunk® Enterprise

Search Tutorial

Splunk Enterprise version 7.2 is no longer supported as of April 30, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk® Enterprise. For documentation on the most recent version, go to the latest release.

Create dashboards and panels

In this section, you will save a search as a dashboard panel and add an input element to the dashboard.

Save a search as a dashboard panel

  1. Start a new search.
  2. Change the time range to Yesterday.
  3. Run the following search.

    sourcetype=access_* status=200 action=purchase | top categoryId

    If no results are returned, expand your time range to Previous week.


    This search returns events from web server access log files for successful (status=200) purchases. The top command automatically returns the count and the percent.
    This screen image shows the results of the search on the Statistics tab. The three columns displayed in the results are category ID, count, and percent. The category ID column displays the type of game or product, such as STRATEGY, SIMULATION, and TEE (for t-shirts).


  4. Click the Visualization tab. The displays shows a Line Chart.
  5. Change the Line Chart to Pie Chart.
    This screen image shows the Visualizations tab. The chart has been changed to a Pie chart. The STRATEGY piece of the Pie chart is the largest piece.


  6. Click Save As and select Dashboard Panel.
  7. Define a new dashboard and dashboard panel.
    1. For Dashboard, click New.
    2. For Dashboard Title, type Buttercup Games - Purchases.
      The Dashboard ID field displays buttercup_games__purchases.
    3. For Dashboard Description, type Reports on Buttercup Games purchases data.
    4. For Dashboard Permissions, keep the default setting Private.
    5. For Panel Title, type Top Purchases by Category.
    6. For Panel Content, keep the setting for Pie Chart.
      This screen image shows the Save As Dashboard Panel dialog box. All of the fields are filled in as described in the previous steps.


  8. Click Save.
  9. In the confirmation dialog box, click View Dashboard. This screen image shows the new dashboard "Buttercup Games - Purchases". There is one panel entitled Top Purchases by Category, which shows the Pie chart.

You now have a dashboard with one report panel. To add more report panels, you can either run new searches and save them to this dashboard, or you can add saved reports to this dashboard. You will add more panels to this dashboard in the next section.

For now, let's spend a little bit more time on this dashboard panel.

View and edit dashboard panels

There is a separate view to see a list of the dashboards that you have access to. From this view, you can create dashboards, and make changes to dashboards and dashboard panels.

  1. Click Dashboards in the App bar to see the Dashboards view.

    You might see a pop-up dialog box asking if you want to take a tour about dashboards. If you take the tour, there is an option at the end of the tour to try dashboards yourself. This option displays the Dashboards view.

    In addition to the Buttercup Games - Purchases dashboard that you created, there are several built-in dashboards in the list.
    This screen image shows the Dashboards view. There are three dashboards listed. One is the Buttercup Games - Purchases dashboard that you created. The other dashboards are built-in to the Splunk product. There are six columns in this view. The first column is the information column which you use to see detailed information about the dashboards. The second column displays the Title of the dashboards. The third column is the Actions column and contains an "Edit" drop down. The remaining columns are "Owner", "App", and "Sharing".


  2. For the Buttercup Games - Purchases dashboard, click the arrow ( > ) symbol in the i column to expand the dashboard information.

    You can see information about the app that this dashboard is associated with, whether or not the dashboard is scheduled, and the dashboard permissions.
    This screen image shows the expanded information for the Buttercup Games - Purchases dashboard.

Add controls to a dashboard

You can add input controls, such as the Time range picker, to dashboard panels.

  1. In the Dashboards list, click Buttercup Games - Purchases to display that dashboard.
  2. Click Edit.
    This screen image shows the Buttercup Games - Purchases dashboard, with the Edit button highlighted.

    You can either edit the dashboard using the UI or the Source. With the UI option you can add panels and inputs to the dashboard.
    • You can use the Add Panel option is used to create a new panel, add a report as a panel, or clone from an existing dashboard.
    • You can use the Add Input option to choose from a list of controls to add to the dashboard, including text, a checkbox, and a time range picker.
    • You can use the Dark Theme option to change the background appearance of the dashboard. To enable the theme change, you must Save and Refresh the dashboard.


    With the Source option, you can edit the XML source for the panel directly. Editing the source directly is not discussed in this tutorial.

    This screen image shows the editing options on the Edit Dashboards page. The UI and Source options enable you to view the dashboard as it appears in the UI or to view the XML source code.


  3. Click Add Input, and select Time.
    This screen image shows the options on the Add Input drop-down list. The options are Text, Radio, Dropdown, Checkbox, Multiselect, Link List, Time, and Submit.

    The Time range picker input control appears on the dashboard.
    This screen image shows the Time range picker control added to the upper-left corner of the dashboard.


  4. Click the Edit Input icon for the Time range picker. The icon looks like a pencil.
    This opens a set of input controls. The Time input type is selected.
    This screen image shows the options for the time range picker control. The options include adding a label to the control and specifying a default time range.
    1. For Label, type Time range.
    2. For Token, replace the default token namefield1. Type BG_Purchases_Time_Range.

      The controls that you add to a dashboard have identifiers called input tokens. This step redefines the name of the input token for the Time range picker. The default names for input tokens are field1, field2, field3, and so on. You can change the input tokens when you add controls to your dashboard. Naming the tokens makes it easier to understand which input you are working with. In this example you are using a token name that includes the a short version of the dashboard title.
    3. For Default, change the default time range to Previous week.
    4. Click Apply.


    The input controls that you add to a dashboard are independent from the dashboard panels. If you want the chart on the panel to refresh when you change the time range, you need to connect the dashboard panel to the Time range picker input control.

  5. In the dashboard panel, click the Edit Search icon. This screen image shows the Edit Dashboard dialog box. The panel icons are on the right side of the panel. There are 4 icons for you to edit the search, select the visualization, format the visualization, and perform more actions. The Edit Search icon looks like a magnifying glass.


  6. In the Edit Search dialog box, for Time range the default selection is Use time picker. Click to see the options. You want to select Shared Time Picker (BG_Purchases_Time_Range).
    This screen image shows the Edit Search dialog box with the Shared Time Picker selected.


  7. Click Apply.
  8. In the Edit Dashboard window, click Save to save the changes to the dashboard.
    The panel is now connected to the Time range picker input control in the dashboard. This Time range picker is referred to as the shared time picker. The inline search that powers the panel now uses the time range that is specified in the shared time picker.
    This screen image shows the updated Buttercup Games - Purchases dashboard.

You can have dashboards that contain a mix of panels. Panels that are connected to the shared Time range picker, and panels that show data for the time range specified in the search that the panel is based on.

You will learn more about connecting other panels to the shared time picker in the next section.

Next step

Learn about adding more panels to a dashboard.

See also

About the Dashboard Editor in Dashboards and Visualizations

Last modified on 23 April, 2019
 

This documentation applies to the following versions of Splunk® Enterprise: 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

Acrobat logo Download manual
Acrobat logo Download this page

Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters