Oracle Cloud Infrastructure Documentation

Configuring Widgets

Configure Console Dashboards widgets so that they give you insight into your resource usage, billing, and system health. Each dashboard can contain multiple widgets.

Note

A single dashboard can contain a maximum of 20 widgets. If you need more than 20 widgets, create additional dashboards.

Types of Console Dashboards Widgets

Console Dashboards support the following types of widget (Applications services support only Resource Explorer, Monitoring, and Markdown).

The following sections describe the dashboard widgets and explain how to configure them. For general steps explaining how to add widgets to dashboards, see Managing Widgets.

Infrastructure Billing

Administrators and users with appropriate permissions can view the infrastructure billing widget. The infrastructure billing widget lets you quickly view your current charges or usage and the days elapsed in your billing cycle. Your view depends on your account type.

  • Pay As You Go customers see the current charges and the number of days elapsed in the current billing cycle.
  • Universal credit customers see the total credits used and number of days elapsed in the credit period.
  • Trial customers see the total credits used and number of days elapsed in the trial period.

To get a more detailed view of your spending, click the Analyze costs link to go to the Cost Analysis tool where you can generate charts and reports of aggregated cost data for your Oracle Cloud Infrastructure consumption. If your account is a Free Tier or promotional trial account, you see an option to Upgrade your account. If you have a paid account, you see the option to Manage payment method to view or change your payment method.

To add the infrastructure billing widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Infrastructure Billing.
  3. Click Save.

Cost Management

Administrators and users with appropriate permissions can view the cost management widget. The cost management widget helps you track and optimize your Oracle Cloud Infrastructure spending by generating charts and reports of aggregated cost data.

The Cost Analysis Overview includes more information about the Cost Analysis tool and detailed descriptions of the Cost Analysis query fields used by this widget.

To add the cost management widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Cost Management.

    The default cost management chart displays.

  3. On the widget, click the Actions icon (Actions Menu), and then click View and edit settings. The Cost Management chart widget configuration dialog opens.
  4. For Name, enter a name for the widget. Avoid entering confidential information.
  5. For Description, enter a description for the widget (optional).
  6. For Configure metric query, make the following selections:
    1. Time range: Select a predefined time range for data available in the usage store.
    2. Granularity: Select the granularity of the chart. Options are based on the selected time range.
    3. Chart type: Select the chart type.
    4. Filters: Click Add Filter to apply filters to the chart data.
    5. Grouping dimensions: Select the grouping used to aggregate the chart data.
  7. Click Preview changes at any time to preview the chart.
  8. Click Submit, and then click Save.
To export the chart as a PDF
  1. On the widget, click the Actions icon (Actions Menu), and then click Export as PDF.

    The chart is exported as a PDF.

To expand the chart
  1. On the widget, click the Actions icon (Actions Menu), and then click Expand chart.

    The chart is expanded to a larger size.

  2. Optionally, change the Chart type.
  3. To return to your dashboard, close the window.

Logging Chart

Use the logging chart widget to create visualizations with the data stored in the Oracle Cloud Infrastructure Logging service.

To use the logging chart widget, you first need to enable logs for resources. After you enable a log, log entries begin to appear on the detail page for the log, and you can use this data to build charts with the logging chart widget. For instructions, see Enabling Logging for a Resource.

The Logging service contains three kinds of logs:

  • Audit logs: Logs related to events emitted by the Oracle Cloud Infrastructure Audit service. These logs are available from the Logging Audit page, or are searchable on the Search page alongside the rest of your logs.
  • Service logs: Emitted by OCI native services, such as API Gateway, Events, Functions, Load Balancer, Object Storage, and VCN Flow Logs. Each of these supported services has pre-defined logging categories that you can enable or disable on your respective resources.
  • Custom logs: Logs that contain diagnostic information from custom applications, other cloud providers, or an on-premise environment. Custom logs can be ingested through the API, or by configuring the Unified Monitoring Agent. You can configure an OCI Compute instance/resource to directly upload Custom Logs through the Unified Monitoring Agent. Custom logs are supported in both a virtual machine and bare metal scenario.
To add a logging chart widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Logging chart.
  3. In the widget, click Configure. The Logging Chart Widget Configuration dialog opens.
  4. For Name, enter a name for the widget. Avoid entering confidential information.
  5. For Description, enter a description for the widget (optional).
  6. For Region, select a region. The logging chart data that displays in the widget comes from the region that you select.
  7. For Set visualization parameters, make the following selections:
    1. Visualization Type: Select the chart type.
    2. Interval: Select the time interval between chart refreshes.
    3. Group By: Select the criteria to use for grouping the logging data in the visualization.
    4. Filter by time: Select the time intervals to use as a filter for the chart.
  8. For Select and filter the logs, make the following selections:
    1. For Custom filters, enter search filters, such as log fields, text search, or time intervals.
    2. For Select logs to search, enter compartments, log groups, or logs to filter by. You can filter by multiple compartments and log groups.

    See Basic Search Queries for more information about searching and filtering logs.

  9. Click Submit, and then click Save.

Logging Data Table

Use the logging data table widget to add a table that displays the data stored in the Oracle Cloud Infrastructure Logging service.

To use the logging data table widget, you first need to enable logs for resources. After you enable a log, log entries begin to appear on the detail page for the log. For instructions, see Enabling Logging for a Resource.

The Logging service contains three kinds of logs:

  • Audit logs: Logs related to events emitted by the Oracle Cloud Infrastructure Audit service. These logs are available from the Logging Audit page, or are searchable on the Search page alongside the rest of your logs.
  • Service logs: Emitted by OCI native services, such as API Gateway, Events, Functions, Load Balancer, Object Storage, and VCN Flow Logs. Each of these supported services has pre-defined logging categories that you can enable or disable on your respective resources.
  • Custom logs: Logs that contain diagnostic information from custom applications, other cloud providers, or an on-premise environment. Custom logs can be ingested through the API, or by configuring the Unified Monitoring Agent. You can configure an OCI Compute instance/resource to directly upload Custom Logs through the Unified Monitoring Agent. Custom logs are supported in both a virtual machine and bare metal scenario.
To add a logging data table widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Logging data table.
  3. In the widget, click Configure. The Logging Data Table Widget Configuration dialog opens.
  4. For Name, enter a name for the widget. Avoid entering confidential information.
  5. For Description, enter a description for the widget (optional).
  6. For Region, select a region. The logging data that displays in the widget comes from the region that you select.
  7. For Select and filter the logs, make the following selections:
    1. For Custom filters, enter search filters, such as log fields, text search, or time intervals.
    2. For Select logs to search, enter compartments, log groups, or logs to filter by. You can filter by multiple compartments and log groups.
    3. Filter by time: Select the time intervals to use as a filter for the table.

    See Basic Search Queries for more information about searching and filtering logs.

  8. Click Submit, and then click Save.

Markdown

Use the markdown widget to include and format text-based content in your dashboard.

To add a markdown widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Markdown widget.
  3. In the widget, click Configure. The Markdown widget configuration dialog opens.
  4. In Name, enter a name for the widget. Avoid entering confidential information.
  5. In Description, enter a description for the widget (optional).
  6. In the Markdown content field, enter text formatted with Markdown. For information about using Markdown, see the Markdown Guide. You can preview the content in the Preview markdown field.
  7. Click Create widget, and then click Save.

Monitoring

Use the monitoring widget to view metric data stored in the Oracle Cloud Infrastructure Monitoring service.

To configure the monitor chart widget, you first need to configure metric queries. See Building Metric Queries for more information.

To add a monitoring widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Monitoring.
  3. In the widget, click Configure. The Monitoring Widget Configuration dialog opens.
  4. For Name, enter a name for the widget. Avoid entering confidential information.
  5. For Description, enter a description for the widget (optional).
  6. For Set visualization parameters, make the following selections:
    1. Chart type: Select the chart type.
    2. Interval: Select the time interval between chart refreshes.
    3. Filter by time: Select the time interval to use as a filter for the chart.
  7. For Configure metric query, make the following selections:
    1. If you want to change the compartment, click Change Compartment and choose a different compartment.
    2. For Region, select a region.
    3. For Namespace, select the service or application emitting metrics for the resources that you want to monitor.
    4. For Metric Name, enter the name of the metric. You can only specify one metric. Metric selections depend on the selected compartment and metric namespace.
    5. For Statistic, select function to use to aggregate the data.
  8. Optionally, configure the Metric Settings.
    1. For Dimension Name, select a qualifier specified in the metric definition from the list. For example, the dimension resourceId is specified in the metric definition for CpuUtilization.
    2. For Dimension value, select the value you want to use for the specified dimension from the list. For example, the resource identifier for your instance.
    3. If desired, click + Additional Dimension to add another name-value pair for a dimension.

      To remove a dimension name-value pair, click the Remove (x) button.

  9. Click Submit, and then click Save.

Resource Explorer

Use the resource explorer to get an overview of the number and types of resources that exist in a selected compartment and region.

To add and use the resource explorer widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Resource explorer.
  3. Click Save.
  4. The resource explorer displays the list of services and count of resources in the selected compartment  and region . By default, the root compartment is selected. To view another compartment, click the Actions icon (Actions Menu), and then click View and edit settings, make changes, and click Update.
  5. Expand the entry for a service to see the count for each resource-type within the service.
  6. To see more information about a resource-type in the list, click the resource-type to open the detailed list. To navigate directly to a specific resource in the list, click the Display name.

Resource Query

Use resource queries to get detailed resource information. You can filter by region, compartment, resource type, or write an advanced query using Search Language Syntax.

To add and use the resource query widget
  1. On the Console home page, click the Dashboard tab.
  2. Follow the steps to add a widget and choose Resource query.
  3. In the widget, click Configure. The Resource query widget configuration dialog opens.
  4. For Name, enter a name for the widget. Avoid entering confidential information.
  5. For Description, enter a description for the widget (optional).
  6. For Resources scope, make the following selections:
    1. Region: Select the region to query for resources (optional).
    2. Select compartments to search: Select one or more compartments containing the resources.
    3. Filter by resource types: Select one or more resource types to filter results (optional).
  7. Optionally, click Switch to advanced resource query, enter a resource query, and click Search. See Search Language Syntax for guidance on creating your query.

  8. The Resources preview table shows the results of your query.

  9. Click Update.