Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Dashboards provide summary views for most of the data and trends in your Grid. Grid Manager includes a list of default dashboards. For more information, see Predefined Dashboards. Infoblox recommends not to modify the default dashboards. If you need to modify the settings of a default dashboard, you can either clone a default dashboard, or create a new dashboard from scratch and then add panels and reports. For example, you can create a new dashboard called "DNS and DHCP Activities," and then add DNS report, add DHCP related reports, such as DHCP Top Lease Clients and DHCP Lease History, to the new dashboard. When you save the "DNS and DHCP Activities" dashboard, the reporting server saves all the reports added to the dashboard and displays dashboard with updated data. By doing this, user-defined dashboards can provide single point of access to review multiple reports that are relevant to the activities you want to monitor. If you modify a default dashboard, you can reset to its default settings. Each dashboard comes with a set of filters to further refine report data.

Warning

Infoblox recommends that you do not modify the predefined dashboards even if you have appropriate permissions. Editing the default dashboards changes the default settings and your changes become permanent. In addition, you might not be able to see the latest changes made by Infoblox. You can select a default dashboard and clone it to modify any of the settings such as permissions, panels, and so on. For more information, see Cloning Dashboards below.

In the Dashboard panel, you can do the following using the Edit drop-down list:

  • Edit panels as described in the Editing Dashboards section below.

  • Edit source, title, and description.

  • Edit permissions as described in the Editing Permissions section below.

  • Clone a dashboard as described in the Cloning Dashboards section below.

  • Reset dashboards, as described in the Resetting Dashboards section below.

Note

You cannot set any dashboard as the home dashboard. The Set as Home Dashboard option available in the Edit drop-down list does not add a dashboard to the Home Dashboard tab. 

Creating New Dashboards

When you add a new dashboard, Grid Manager displays it in the Reporting -> Dashboards tab. You can add multiple panels and reports to the new dashboard.
To create a new dashboard:

  1. From the Reporting tab -> select the Dashboards tab.

  2. Click Create New Dashboard.

  3. Complete the following:

    • Dashboard Title: Enter the dashboard title.

    • Description: Enter the dashboard description.

    • Permissions: Click Shared in App to share a dashboard to other users. Depending on their permissions, other users can edit the dashboard. When Private is selected, the dashboard is available only to the user who creates it. You can change permissions later while editing a dashboard.

    • Select Classic Dashboards or Dashboard Studio and choose Absolute or Grid layout to create a dashboard in Dashboard Studio.
      Classic Dashboards type of dashboard is the traditional Splunk dashboard builder.
      Dashboard Studio type of dashboards are new type of dashboards available with latest version of Splunk. For details on Splunk Dashboard Studio, please refer https://docs.splunk.com/Documentation/Splunk/8.2.4/DashStudio/IntroFrame.

  4. Click Create.

Note

  • Uploading a background image or icons to Dashboard Studio type dashboards is not supported.

  • There are no pre-defined dashboards available for Dashboard Studio.

Cloning Dashboards

It is not recommended to modify default dashboards. You can select a default dashboard and clone it to modify any of the settings, such as permissions, panels, and so on.

Note

You do not need any permission to create, modify, and delete your own personal dashboard. However, limited-access users need Read and Write permissions to modify cloned dashboards. For information about administrative permissions, see Administrative Permissions.

When you clone a dashboard, you can do the following:

  • View and set permissions, as described in Editing Permissions, see Administrative Permissions.

  • Schedule PDF delivery, as described in Scheduling PDF Delivery for Dashboards below.

  • Edit panels, as described in Editing Dashboards below.

To create a personal dashboard:

  1. From the Reporting tab, select the Dashboards tab.

  2. Select the dashboard you want to modify, click Edit -> Clone.

  3. Enter a new title, ID, and description.

  4. Set its permissions. Select Private if you do not want to share the cloned dashboard with other users. Select Clone if you want the cloned dashboard to have the same permissions as the original dashboard.

  5. Click Clone Dashboard.

  6. Optionally, you can edit permissions, as described in Editing Permissions, see Administrative Permissions or click View to view the cloned dashboard.

Resetting Dashboards

Infoblox recommends not to modify default dashboards. However, when you make changes to the default dashboards, you can reset to its default settings.
To reset a dashboard:

  1. From the Reporting tab -> select the Administration tab.

  2. Click Reset Dashboards.

  3. Select the checkbox of the dashboard or Select all to select all the dashboards.

  4. Click Reset selected dashboards.

The dashboard you have modified will reset to its default settings.

Editing Dashboards

To edit the panels and filters of a dashboard, it is recommended to clone the default dashboard, and then add panels, filters and reports to the cloned dashboard. When you add a report to the panel, Grid Manager generates the corresponding dashboard in the panel. When you save the dashboard, Grid Manager updates reports in each panel. Alternatively, you can edit the XML source code to add filters and panels to a cloned dashboard, as described in Editing the XML Source Code of a Dashboard below.
To add panels and filters to a dashboard:

  1. From the Reporting tab -> select the Dashboards tab ->  select a dashboard.

  2. From the Edit drop-down list, select Edit Panels.

  3. In the Edit: <Dashboard> pane, you can click Add Panel or Add Input or Edit Source.
    Note that you cannot modify or delete the default values set for the dashboard filters. For example, you cannot delete or modify the filter All set for Members. When you add a new input using the editor, make sure that you edit the source and refer to the token for the input in the search string. By doing so, the search is updated when you change the input value. For information editing source, refer to Splunk documentation.

  4. Optionally, you can click  to delete a filter. When you delete a filter, make sure that you delete the filter information from the XML source code as well. For information, see Editing the XML Source Code of a Dashboard below.

  5. Expand the panel categories and select the panel you want to add. For detailed information about how to add panel categories, refer to the Splunk documentation.

  6. Click Add to Dashboard.

Editing the XML Source Code of a Dashboard

Note

Before editing dashboards, forms, and panel files in simple XML source code, you should be familiar with the basic layout of dashboards and the XML elements that define them. Infoblox recommends that you save a copy of the source code of the dashboard before making any modifications.

To edit the XML source code for a dashboard:

  1. From the Reporting tab, select the Dashboards tab.

  2. Select a dashboard you want to edit the XML source code, click Edit -> Edit Source.

You can add filters, such as checkbox, drop-down list, radio button, and text box. For information about how to edit the XML source code, refer to the Splunk documentation.

Example - Adding an extensible attribute filter

If your reporting data contains the "location" extensible attributes associated to members, adding the following sample XML code to the XML source code will create an extensible attribute filter, Member Location:

<input type="dropdown" token="ea_location">

       <label>Member Location</label>

       <choice value="All">All</choice>

       <default>All</default>

       <search>

         <query>| inputlookup __grouping_by_ea_tag_lookup

                | spath input=EA path=Location output=EA_Location

                | stats count by EA_Location </query>

         <earliest>$time.earliest$</earliest>

         <latest>$time.latest$</latest>

      </search>

      <fieldForLabel>EA_Location</fieldForLabel>

      <fieldForValue>EA_Location</fieldForValue>

      <change>

        <condition value="All">

          <set token="ea_location_str"> | noop </set>

        </condition>

        <condition value="*">

         <set token="ea_location_str"> | spath input=EA path=Location output=EA_Location

                                       | where EA_Location="$value$"</set>

        </condition>

      </change>

</input>

<search id="base_search">

   <query>index=ib_system_summary report=si_cpu_usage

          $members$

          $ea_site_str$

          $ea_location_str$

          $group_by_str$

          $group_by_stats$

            | timechart bins=1000 $calculation_method$(CPU_PERCENT) by $time_chart_field$

where max in $topn$ useother=f

         | interpolate 1200</query>

   <earliest>$time.earliest$</earliest>

   <latest>$time.latest$</latest>

</search>

Scheduling PDF Delivery for Dashboards

To schedule PDF delivery for dashboards, you must first create a new dashboard. Ensure that email notification settings are configured prior to scheduling PDF delivery. For more information about Configuring Email Notification Settings, see About Alerts. To schedule PDF delivery, you can use the dashboard Edit drop-down list. You can access the Edit drop-down list directly from a dashboard or from the Dashboards page.

Note

Scheduled PDF delivery is not available for dashboards that include forms.

Do the following if the Schedule PDF Delivery option is disabled:

  1. Open the dashboard for which you want to schedule PDF delivery.

  2. Click Open in Search icon available at the bottom of the dashboard panel.

  3. From the Save As menu, click Dashboard Panel.

To set up PDF delivery for the dashboard with a single panel:

  1. From the Reporting tab, select the Dashboards tab.

  2. Do one of the following:

    • Select the dashboard you want to schedule, click Edit -> Schedule PDF Delivery. If the Schedule PDF Delivery option is disabled, follow the steps as described above.

    • Open the dashboard in the Dashboards page and click Schedule PDF Delivery from the Edit drop-down list.

  3. In the Edit PDF Schedule dialog box, do the following:

    • Select the Schedule PDF Delivery checkbox to enable PDF delivery.

    • Select a schedule. For more information, refer to the Splunk documentation.

    • In the Email To text box, specify email address.

    • Select paper size and paper layout. You can change the paper size and paper layout, if data is not displayed properly in the PDF delivery.

    • To receive dashboard PDFs immediately, click Send Test Email.

4. Click Save.

Note

To set up PDF delivery for the dashboard with multiple panels, repeat the above steps from step 1 to step 4 and add other panels to the dashboard created for the first panel.

Edit PDF Schedule dialog box

 

  Click Send Test Mail to receive Dashboard PDFs Immediately.

About Dashboard Filters

You can apply different filters to control the data displayed in the dashboards. The data on the dashboard is displayed based on the various filter criteria you select.
To apply a filter:

  1. From the Reporting tab, select the Dashboards tab -> select a dashboard.

  2. Apply filter criteria appropriately and click Submit
    The dashboards display results based on the filters that you apply.

The most common filters are as follows:

  • Time

  • Top N: Topmost filter options. The default is 10. You can select from a set of fixed values for the TopN filter setting: 5, 10, 20, 50, 100, 200, 250, or 500.

  • Members: Grid members configured on the appliance.

  • Network

  • Member Site, as described in Applying Extensible Attribute Filters below.

Applying Time Filters

You can generate a dashboard for a specific time interval by applying time filters. You can filter results by preset time ranges, create custom time ranges, specify time ranges based on dates or date and time, or work with advanced features in the time range picker. For information about Time range picker, refer to the Splunk documentation.
The date and time displayed in the Time filters are based on the time zone set in your user profile by default. For more information about how to configure a time zone, see Setting the Browser Time Zone in Setting Login Options. However, the timestamp displayed in the results for a dashboard is based on the time zone configured on the reporting server.

Note

The NIOS reporting data is updated at a certain time interval, rather than updating continuously. Therefore, the Real-time option in the Time filter might not work for most of the dashboards. For information about update time intervals, see Reporting Indexes and Update Time Intervals in About Reports.

Applying Extensible Attribute Filters

You can use extensible attribute filters to narrow down the search by including only members that contain certain extensible attribute values. An extensible attribute added to a member is displayed in the Extensible Attribute filter. For information about managing extensible attributes, see Managing Extensible Attributes. When you configure group-by-extensible-attribute search and apply the Extensible Attribute filter, the dashboard displays results for grouped members that have the same extensible attribute value for the Site extensible attribute. If you have configured multiple attribute values for a member, then applying the Extensible Attribute filter displays all the attribute values associated with that member. For example, if member 1 has predefined attribute Site with attribute values member a and member b and member 2 has predefined attribute Site with attributes values member c and member d, then the dashboard displays member a and member b when you apply the Member Site <member 1> filter.
In addition, you can apply Group By EA Tag filter and group members with the same extensible attribute value so that instead of displaying data per member, the reports display data per group of members with the same value for the Site extensible attribute. When you apply Group By EA Tag filter, you can set the data calculation method to decide which statistic value [Aggregate, Average, or Maximum] you want to be displayed for grouped members. You can group by Active Directory Sites for the IPAMv4 Network Usage Statistics report, IPAMv4 Top Utilized Networks report, and DHCPv4 Network Usage Statistics report.
To apply an extensible attribute and group by EA tag/field filters:

  1. From the Reporting tab, select the Dashboards tab -> select a dashboard.

  2. In the filter section, complete the following:

    • Member <Extensible Attribute>: Select an extensible attribute configured for a member. If you need an additional extensible attribute filter, you must first clone the default dashboard, and then add an extensible attribute filter by editing the XML source code. For information, see Editing the XML Source Code of a Dashboard above.

    • Group By EA Tag/Field: Select an extensible attribute to enable the reporting server to group networks by members that have certain extensible attribute tags or fields. Note that this option is available for specific dashboards only.
      Note that if you use special characters in the extensible attribute name, the appliance replaces these special characters with equivalent values. For example, the extensible attribute Site In London is displayed as Site20In20London in the Group By EA Tag/Field drop-down list. In this example, space is replaced with 20. If you add the extensible attribute London@, it is displayed as London40 in the Group By EA Tag/Field drop-down list.

    • Calculation Methods: This field is enabled only when you select the Group by EA Tag/Field checkbox. The displayed result varies based on your search definitions. The result values can contain information such as event counts, DNS queries, traffic rate, and usage trends. For example, when you select Maximum, the DNS Query Rate by Member dashboard shows all the members that have the same extensible attributes and members with the maximum DNS queries, and the Threat Protection Event Count By Member dashboard shows the members that have the same extensible attributes and maximum event counts. Select one of the following methods:

      • Aggregate: Displays the sum of values for individual members in a group.

      • Average: Displays the mathematical average of a group. This value is obtained by adding values for all members in a group and then dividing the total by the number of members.

      • Maximum: Displays the maximum value among the members in a group.

Note

When you apply GroupByEATag/Field in Active Directory Sites supported reports, the values displayed in these reports are aggregated sum of absolute values (sum of values of individual networks in a group) and utilization% is the mathematical average of the group.

You can configure the group-by-extensible-attribute filter and data calculation methods for the following dashboards only. For more information about these dashboards, see Predefined Dashboards.

  • CPU Utilization Trend (Detailed)

  • IPAMv4 Network Usage Statistics

  • IPAMv4 Top Utilized Networks

  • IPAMv4 Network Usage Trend

  • DDNS Update Rate Trend

  • DHCPv4 Usage Statistics

  • DNS Daily Query Rate by Member

  • DNS Query Rate by Member

  • DNS Daily Peak Hour Query Rate by Member

  • DNS Response Latency Trend

  • DNS Cache Hit Rate Trend

  • DNS Traffic Control Resource Availability Trend

  • DNS Traffic Control Resource Pool Availability Trend

  • DNS Traffic Control Response Distribution Trend

  • Memory Utilization Trend

  • Traffic Rate by Member

  • Threat Protection Event Count By Member

  • Threat Protection Event Count By Member Trend

  • No labels