Dashboards

A dashboard is a set of charts. This topic covers:

Dashboard Types

A default dashboard is a predefined set of charts that you cannot change. In a default dashboard you can:
A custom dashboard contains a set of charts that you can change. In a custom dashboard you can:

When you first display a page containing charts it has a custom dashboard with the same charts as a default dashboard.

Creating a Dashboard

  1. Do one of the following:
  2. Specify a name and optionally a duration.
    Conventional dashboard names follow the patterns given by one of the following Java regular expressions: 
    Pattern.compile("^(.+):(\\d):" + STATUS_VIEW_SUFFIX + "$");
    Pattern.compile("^(.+):" + STATUS_VIEW_SUFFIX + "$");
    Examples of expected names are: HOST:STATUS_VIEW, MGMT:STATUS_VIEW, or HDFS:5:STATUS_VIEW. If the dashboard name does not match the expected pattern, a warning will be displayed in the server log.
  3. Click Create Dashboard.

Managing Dashboards

To manage dashboards, select Charts > Manage Dashboards. You can create, clone, edit, export, import, and remove dashboards.
  • Create Dashboard - create a new dashboard.
  • Clone - clones an existing dashboard.
  • Edit - edit an existing dashboard.
  • Export - exports the specifications for the dashboard as a JSON file.
  • Import Dashboard - reads an exported JSON file and recreates the dashboard.
  • Remove - deletes the dashboard.

Configuring Dashboards

You can change the time scale of a dashboard, switch between default and custom dashboards, and reset a custom dashboard.

Setting the Time Scale of a Dashboard

By default the time scale of a dashboard is 30 minutes. To change the time scale, click a duration link at the top-right of the dashboard.

Setting the Dashboard Type

To set the dashboard type, click and select one of the following:
  • Custom - displays a custom dashboard.
  • Default - displays a default dashboard.
  • Reset - resets the custom dashboard to the predefined set of charts, discarding any customizations.

Saving Charts to Dashboards

Minimum Required Role: Configurator (also provided by Cluster Administrator, Full Administrator)

You can save the charts and their configurations (type, dimension, and y-axis minimum and maximum) to a new dashboard or to an existing dashboard.

If your tsquery statement resulted in multiple charts, those charts are saved as a unit (either to a new or existing dashboard). You cannot edit the individual plots in that set of charts, but you can edit the set as a whole. A single edit button appears for the set that you saved — typically on the last chart in the set.

You can edit a copy of the individual charts in the set, but the edited copy does not change the original chart in the dashboard from which it was copied.

Saving Charts to a New Dashboard

  1. Optionally modify the chart properties.
  2. If the chart was created with the Chart Builder, optionally type a name for the chart in the Title field.
  3. Do one of the following:
    • New chart - Click Save.
    • Existing chart - Move the cursor over the chart, and click the icon at the top right.
  4. Optionally edit the chart name.
  5. Select the Add chart to a new custom dashboard option.
  6. Enter a dashboard name.
  7. Click Save Chart. The new dashboard appears on the menu under the top-level Charts tab.

Saving Charts to an Existing Dashboard

  1. Optionally modify the chart properties.
  2. If the chart was created with the Chart Builder, optionally type a name for the chart in the Title field.
  3. Do one of the following:
    • New chart - Click Save.
    • Existing chart - Move the cursor over the chart, and click the icon at the top right.
  4. Optionally edit the chart name.
  5. Select the Add chart to an existing custom or system dashboard option.
  6. Select a dashboard from the Dashboard Name drop-down list.
  7. Click Save Chart. The chart is added (appended) to the dashboard you select.

Adding a New Chart to the Home Page Custom Dashboard

You can add new charts to the custom dashboard on the Home > Status tab.
  1. Click and select Add From Chart Builder - displays the Add Chart To Dashboard page, with variables preset for the specific cluster where you want to add the dashboard.
    1. Click the question mark icon to the right of the Build Chart button and select a metric from the List of Metrics, type a metric name or description into the Basic text field, or type a query into the Advanced field.
    2. Click Build Chart. The charts that result from your query are displayed, and you can modify their chart type, combine them using facets, change their size and so on.
  2. Click Add.

Adding a New Chart to the Custom Dashboard

You can add new charts to the custom dashboard on the Status tab of a service, host, or role.

  1. Click and select one of the following:
    • Add From Charts Library - displays the charts page.
      1. Select one or more charts.
    • Add From Chart Builder - displays the Add Chart To Dashboard page, with variables preset for the specific service, role, or host where you want to add the dashboard.
      1. Click the question mark icon to the right of the Build Chart button and select a metric from the List of Metrics, type a metric name or description into the Basic text field, or type a query into the Advanced field.
      2. Click Build Chart. The charts that result from your query are displayed, and you can modify their chart type, combine them using facets, change their size and so on.
  2. Click Add.

Removing a Chart from a Custom Dashboard

Minimum Required Role: Configurator (also provided by Cluster Administrator, Full Administrator)

  1. Move the cursor over the chart, and click the icon at the top right.
  2. Click Remove.

Moving and Resizing Charts on a Dashboard

You can move or resize the charts on a dashboard:

  • Drag charts to a dashboard to change their relative positions.
  • Change the size of a chart on a dashboard by dragging the lower-right corner of the chart.