Managing Console Dashboards

Dashboards let you monitor resources, diagnostics, and key metrics for your tenancy in the Oracle Cloud Infrastructure Console. Dashboards are fully customizable: you choose which widgets to use and how to display the data. This topic explains how to create, edit, and manage your dashboards.

Using the Console

You can use the Console to build, edit, and manage dashboards.

Building Console Dashboards

You can use the Console to build dashboards.

To create a dashboard
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. Click New dashboard. The Create new dashboard dialog opens.
  3. In the Create new dashboard dialog, enter the following:
    1. Dashboard name: Enter a name for the dashboard. You can change the name later. The name doesn't need to be unique, because an Oracle Cloud Identifier (OCID) uniquely identifies the dashboard. Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\. Avoid entering confidential information.
    2. Description: (Optional) Enter a description for the dashboard. The following special characters are not allowed: <>()=/'"&\.
    3. Resource compartment: Select the compartment to create the dashboard in.
    4. Choose either Select existing dashboard group or Create new dashboard group.
      • If you choose Select existing dashboard group, for Dashboard group, select a dashboard group in the same compartment as the dashboard.
      • If you choose Create new dashboard group, for Dashboard group name, enter a name for the dashboard group. Avoid entering confidential information. See Working with Console Dashboards Groups for more information about dashboard groups.
  4. (Optional) Click Show additional options. The Add tags tab opens.

    If you have permission to create a resource, then you also have permission to apply free-form tags to that resource. To apply a defined tag, you must have permission to use the tag namespace. For more information about tagging, see Tagging. If you are not sure whether to apply tags, skip this option (you can apply tags later) or ask your administrator.

  5. Click Create.
To add widgets to the dashboard
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. To add widgets, click + Add widget.

    The Add new widget dialog opens.

  4. Select a widget, and if applicable, click Configure. For configuration instructions for each widget, see Types of Console Dashboards Widgets.
  5. After adding the desired widgets, click Save.

Managing Widgets

After you add widgets to your dashboard, you can edit, refresh, duplicate, and delete widgets. For information about configuring widgets, see Configuring Widgets.

To edit widgets
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. On the widget you want to edit, click the Actions icon (Actions icon), and then click View and edit settings.

    The widget configuration dialog opens.

  4. Change your configuration settings. For widget configuration details, see Configuring Widgets.
  5. Click Submit.
To refresh widget data
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. On the widget you want to refresh, click the Actions icon (Actions icon), and then click Refresh chart.
To duplicate widgets
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. On the widget you want to duplicate, click the Actions icon (Actions icon), and then click Duplicate widget.
  4. Click Save.
To delete widgets
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. On the widget you want to delete, click the Actions icon (Actions icon), and then click Delete.
  4. Click Save.

Editing Dashboards

After you create your dashboard, you can change the dashboard name and description, update the layout, move the dashboard to a new compartment, or delete the dashboard.

To change the dashboard name and description
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. In the Dashboard actions menu, click Change name and description.

    The Edit name and description dialog opens.

  4. Enter a new name and description. For the name, leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\. For the description, the following special characters are not allowed: <>()=/'"&\. Avoid entering confidential information.
  5. Click Submit.
To change the dashboard layout
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. To change the layout, click Edit layout.
  4. Drag and drop widgets in new positions on the dashboard, and then click Save.
To move dashboards

You can move dashboards to different compartments and dashboard groups.

  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. In the Dashboard actions menu, click Move.

    The Move dashboard dialog opens.

  4. For Dashboard compartment, select the compartment to move the dashboard to.
  5. Choose either Select existing dashboard group or Create new dashboard group.
    • If you choose Select existing dashboard group, for Dashboard group, select a dashboard group in the same compartment as the dashboard.
    • If you choose Create new dashboard group, for Dashboard group name, enter a name for the dashboard group. Avoid entering confidential information. See Working with Console Dashboards Groups for more information about dashboard groups.
  6. Click Submit.
To delete dashboards
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. In the Dashboard actions menu, click Delete.

    The Delete dashboard dialog opens.

  4. Click Delete.

Using Dashboards

After you create your dashboards, you can search, refresh, duplicate, and switch between dashboards.

To switch or search dashboards
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. Click Change dashboard. The Change dashboard dialog opens.
  3. Click either Search dashboards or View by compartment and dashboard group.
    • If you choose Search Dashboards, in the search box, enter the name of the dashboard. The results include dashboards in all compartments and dashboard groups. Select a dashboard from the list.

      The Change dashboard dialog closes and the dashboard you selected opens.

    • If you choose View by compartment and dashboard group, make the following selections, and then select a dashboard from the list:

      • For Resource comparment, select a compartment.
      • For Dashboard group, select a dashboard group.

      The Change dashboard dialog closes and the dashboard you selected opens.

To refresh the dashboard data
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. To refresh the data manually, click the Refresh dashboard button.
  4. To set the dashboard data to refresh automatically, in the Auto refresh menu, select Auto refresh every 5 min.
To duplicate dashboards
  1. On the Console home page, click the Dashboard tab.

    The default dashboard opens.

  2. If needed, switch dashboards.
  3. In the Dashboard actions menu, click Duplicate.

    A duplicate dashboard is created.

  4. Optionally, rename the dashboard.

Using the API

You can use the Dashboards API to build, edit, and manage dashboards.

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.