Learn how to manage dashboards.

Creating a Dashboard

You can create a dashboard from the All Dashboards page, an existing dashboard, a chart, or the Metrics browser.

  1. Do one of the following:

    • In the All Dashboards page, click the Create Dashboard button on the filter bar.
    • From an existing dashboard, click the pencil icon on the right side of the browser window below the task bar, and select New. You can also click Clone to create a new dashboard based on the existing dashboard you are currently viewing.
    • From a chart, scroll down to the Save to section and click New Dashboard.
    • From the Metrics browser, locate Create Dashboard in the top left corner of the page and click it to begin the process of creating a dashboard. Creating a dashboard this way automatically creates sections and charts based on the current set of metrics in the Metrics list. Sections are created by first-level nodes, individual charts by second-level nodes and finally all metrics on the third-level or below are rendered on a single chart. Creating a dashboard from the Metrics browser also allows you to apply additional parameters such as sources and source tags.

    A Create New Dashboard dialog displays. Enter a URL and name for your dashboard. The URL field supports letters, numbers, underscores, and dashes. If you enter a special character or space, then the URL field turns red and requires you to make changes before saving. The Name field supports letters, numbers, characters, and spaces.

  2. Click Create. The dashboard is created and displays in edit mode.
  3. Click Cancel or edit the dashboard and click Save.

Deploying a Dashboard

Dashboards are stored in JSON format. You can deploy a dashboard JSON file with the Wavefront API using the following command:

curl -v https://<wavefront_instance>.wavefront.com/api/v2/dashboard -d @<dashboard_file>.json \
  -H "Content-Type: application/json" -H 'Authorization: Bearer <wavefront_api_token>'

Setting Dashboard Preferences

To set the dashboard preferences:

  1. Click the wrench icon at the top right of the dashboard.
  2. Edit the preferences.
  3. Click Save.

Cloning a Dashboard

  1. To clone a dashboard:
    • From the All Dashboards page, locate the dashboard and select action_menu.png > Clone.
    • From a dashboard, click the pencil icon on the right side below the task bar, and select Clone.
  2. Specify a new URL.
  3. Optionally edit the dashboard name.
  4. Click Clone.

Editing a Dashboard

When editing a dashboard, you can make changes to the dashboard description, name, dashboard variables, sections, and charts.

  1. To edit a dashboard:
    • From the All Dashboards page, locate the dashboard and select action_menu.png > Edit.
    • From a dashboard, click the pencil icon on the right side below the task bar, and select Edit.

    The dashboard displays in edit mode.

  2. Edit the dashboard.

    When editing a dashboard, you may make several changes at a time. To remove a change, click the revert icon revert.png near the Save button on the task bar. The revert icon removes changes starting with the most recent and works backwards. You can only remove changes made in the current edit mode session.

  3. After any configuration action described in this section, click Save.

Setting the Dashboard Name and Description

  1. Click the <<Edit Dashboard Description>> link. The Dashboard Display Preferences dialog displays.
  2. Rename your dashboard and enter a description.
  3. If you enter a description and want it to be displayed on your dashboard, click Show Description.
  4. Click Accept.

Configuring Dashboard Sections

Charts are contained in sections. By default, every dashboard has at least one section. A section link bar displays directly below the time bar at the top of the dashboard.

Section_Table_of_Contents

Jump to a section by clicking the link in the section bar. If the section link bar is not displayed, turn it on in the Dashboard Display Preferences.

Section_Editing

While editing a dashboard, available sections actions are:

  • Change the name:
    1. Click the name at the far left.
    2. Type a new name.
    3. Press Enter or Return or click anywhere away from the section name.
  • Move, add, or delete. Click icons on the far right.

Resizing Rows

Resize a row within a section by clicking the resize icons resize.png on the left side of each row. Resizing a row resizes every chart in that row.

Editing the Dashboard JSON

You can directly modify any dashboard properties by editing the dashboard’s JSON format. Use this option only if you have a good understanding of JSON. To access the JSON editor:

  1. Put the dashboard in edit mode.
  2. Click Edit JSON next to the Save button on the task bar. The JSON format displays in the Tree editor. You can use the tree controls to expand, collapse, and reorder nodes.

    json tree.png

    You can also edit the JSON code directly by selecting Tree > Code. For example, to change a row height, edit the row’s heightFactor property:

    ...
    ],
      "heightFactor": 100
    },
    ...
    
  3. Click Accept.

Deleting Dashboards

To delete one or more dashboards:

  • In the All Dashboards page:

    • Select the checkboxes next to one or more dashboards and click .
    • Locate a dashboard and select action_menu.png > Delete. Click Delete Dashboard to confirm the delete action.
  • From a dashboard, click the pencil icon and select Delete. Click OK to confirm the delete action.

The dashboard(s) are moved to the Trash. You can view the Trash by clicking the trash toggle: Off - trash_off.png  On - trash_on.png.

You can recover a dashboard within 30 days of being moved to the Trash. After 30 days, the deleted dashboard is removed from the Trash and is no longer recoverable. To permanently remove a dashboard before the 30 day deadline, toggle the Trash icon and manually delete it.

Managing Dashboard Versions

Wavefront keeps track of changes made to a dashboard and displays those changes in the Dashboard History page. You can access a dashboard’s history from the All Dashboards page or directly from the dashboard:

  • From the All Dashboards page, find the desired dashboard in the list and select action_menu.png > Versions.
  • From a dashboard,  click the pencil icon , and select Versions.

From the Past Versions page, each revision is listed along with the user who made the change, the day and time it was updated, and the change description.

To revert a change, select action_menu.png > Revert next to the desired version to go back that version. When you do this, you are asked to confirm that you want to revert. After confirming, you are sent to the dashboard version you chose. If you go back to the Past Versions page, the change is reflected on the list.

You can also choose to view a previous dashboard version before reverting by clicking the number associated with the dashboard change on the Past Versions page.  For a specific dashboard version, select action_menu.png > Clone to create a new dashboard based on the revision you chose.

Managing Dashboard Tags

See Organizing with Tags.

Managing Charts in Dashboards

To make changes to a chart in a dashboard, first put the dashboard in edit mode. After making a change, click Save.

Adding a Chart to a Dashboard

  1. Go to a section. Click  Add New Chart. An Add Chart dialog displays.
    1. In the New Query field, type a Wavefront Query Language expression.
    2. In the Chart section, customize your chart.
    3. Click Accept. The new chart displays in the section you selected.

Deleting, Cloning, and Editing a Chart

  1. Hover over a chart. Three icons display in the bottom left corner of the chart box three_icons.
  2. Delete, clone, or edit the selected chart. When you clone a chart, it is created in a separate row below the selected chart.

You can also edit a chart by clicking the chart name in the top right corner. Save your changes by clicking Save in the chart.

Moving a Chart

To move a chart:

  1. Hover over a chart.
  2. Left-click your mouse and hold. The cursor changes to .
  3. Drag the chart to a new position on the dashboard. You can move the chart to an existing row or to a new row by dragging a chart over an  Add New Chart box.

    You can place up to four charts in a row. The more charts in a row, the smaller each chart will be. The smaller the chart, the fewer the number of point buckets and larger the amount of time represented by each point bucket. See Chart Resolution.

  4. Release the mouse button. The chart is relocated.