Create Dashboards

You can create custom dashboards on the Dashboards page by adding the Oracle-defined widgets or the custom widgets you’ve created. You can also create a duplicate of one of the available dashboards and customize it to meet your requirements.

  1. Open the navigation menu and click Observability & Management. Under Logging Analytics, click Dashboards.
  2. On the Dashboards page, click Create.
  3. Specify the name of the dashboard and optionally, a description, and click Create.
  4. On the new dashboard page, go to About tab. Specify the name of the dashboard, select the dashboard compartment, and optionally provide a description for the dashboard.
  5. In the Widgets pane, search for the Oracle-defined or custom widgets. Click a widget to add it to the dashboard. Alternatively, you can drag and drop the widgets to the dashboard.
    After you’ve added a widget, you can click the Content Settings (content settings) icon on the widget to perform various actions such as altering the size or placement of the widget, hiding or adding the title, linking the title of the widget to an Oracle Cloud Logging Analytics page or dashboard, and removing the widget.

    Additionally, to create and add a metric widget for the metrics generated in other services, click Create Metric Widget. See Create Metric Widget.

  6. Click Done to save the new dashboard.
    After you click Done, the dashboard is in View mode. At a later time, if you want to make changes to the contents of your dashboard, click Edit to go to the Edit mode.

After you’ve created a dashboard, click the name of the dashboard in the Dashboards page to view it. You can use the following options on the Dashboard page to perform other tasks:

  • Click the Open (open in log explorer) icon on a widget to open the widget in the Log Explorer and make changes. If you want to make changes to a widget created by another user, you can click the Save As option in the Log Explorer to create a copy of the widget and make changes to meet your requirements. Note that the copy of the widget isn't automatically added to the dashboard and you'll have to edit the dashboard and add it.
  • Click Edit to modify the dashboard. You can add or remove custom widgets, metric widgets, change the title, description, or dashboard compartment.

For information regarding the Management Dashboard policies that assign the permissions required to work with dashboards, see Details for Management Dashboard.

For Management Dashboard API documentation, see Management Dashboard API.

Use Oracle-Defined Dashboards

Oracle Cloud Logging Analytics provides predefined dashboards with in-built widgets.

The Oracle-defined dashboards are provided to give you an overview of the analysis of some of the important logs. Some examples of Oracle-defined dashboards are Enterprise Network (VCNs) Overview, OCI API Gateway Overview, OCI Audit Analysis, and VCN Flow Logs.


Enterprise Network (VCNs) Overview dashboard

To access Oracle-defined dashboards:

  1. Open the navigation menu and click Observability & Management. Under Logging Analytics, click Dashboards.

  2. On the Dashboards page, sort the dashboards listing by Created By column, and identify the ones that are created by Oracle. Click on the dashboard name that you want to open.

The Dashboard opens. You can view the Oracle-defined widgets that describe the key parameters of the logs for which the dashboard is created. You can change the time rage in the time selector on the top right corner to view data from a different time range. Use the scope filter to define the scope of the log by specifying in the Log Group Compartment field, or the scope of the entities using the Entity Compartment and Entity fields.

To view a widget in the log explorer, click the View in Log Explorer button View in Log Explorer icon on the top right corner of the widget.

You can create a duplicate of the Oracle-defined dashboard and add more widgets to it or edit it to create your custom dashboard.

Customize an Oracle-defined Dashboard

You can also use the Oracle-defined dashboards to create your own custom dashboard:

  1. Open the navigation menu and click Observability & Management. Under Logging Analytics, click Dashboards.

  2. On the Dashboards page, sort the dashboards listing by Created By column, and identify the ones that are created by Oracle. Click on the Action menu icon Actions menu and click Duplicate.

    The Duplicate Dashboard dialog box opens.

  3. In the Duplicate Dashboard dialog box,

    • Specify a name for the duplicate dashboard.

    • Select the compartment where the dashboard must be located.

    Click OK.

    You can locate the new duplicate dashboard in the Dashboards listing page by the name that you specified earlier.

  4. Click on the name of the duplicate dashboard. The Dashboard details page opens.

  5. Click Edit to change the look and feel of the widgets or to add and remove widgets.

  6. Click Done to save your changes.

Create Metric Widget

You can create metric widgets to view saved search generated metric data and other metric data that are stored in OCI Monitoring service.

  1. Open the navigation menu and click Observability & Management. Under Logging Analytics, click Dashboards.

  2. If you want to create a new dashboard and add the new metric widget to it, then in the Dashboards page, click Create Dashboard.

    Alternatively, if you want to add a new metric widget to an existing dashboard, then open the dashboard by clicking on its name in the Dashboards page, and click Edit.

  3. In the Widgets tab on the right of the page, click Create Metric Widget.

    This opens the metric widget creation page.

  4. Click the scope filter button scope filter icon on the top left corner, and select the metric compartment where the metric data is available.

  5. You now must identify the source of data to generate the metrics. Under Data, click Add button Add icon next to Source Data.

    The Add Source Data dialog box opens.

  6. In the Add Source Data dialog box, select the following properties:

    • Data Source: Select All Metric Sources to retrieve data from OCI Monitoring service.
    • Namespace: Select the applicable namespace from those that you have access to.
    • Metrics: Based on the previous two selections, this menu gets refreshed with the names of all the metrics available after applying those filters. Select the metrics that you want to use. Alternatively, to have the option of deciding to select the metrics later, you can specify All Metrics.

    Click Add.

    Repeat steps 5 and 6 to add more metrics to Source Data.

    All the selected metrics are now listed under Source Data.

  7. Drag and drop the metrics that you want to visualize from Source Data section to Y Axis section. Alternatively, in the Source Data section, you can click Actions button Actions icon next to the metric name, and click Add to Y Axis.

    You can now see the chart where the selected data is plotted along Y axis.

    Additionally, you can add more metrics to Y Axis section and visualize multiple metrics together.

  8. You can customize your visualization by specifying or modifying the following visualization options:

    • Time Range: Select the time range from the time selector on the top right corner to have data available for the visualization in that range.
    • Chart Type: You can select from Area Chart, Line Chart or Bar Chart based on the type of data that you want to visualize.
    • Y Axis Title: Specify a title for the data projected on the Y Axis.
    • Legend: You can specify the location of the legend as Top, Bottom, Left, Right, or None. If you have multiple metrics in the visualization, then you can hover on the legend of a specific metric to emphasize that data in the combined chart.
    • Correlated Tooltips: If you want to correlate the tooltips across all your metric widgets in the dashboard, then check this box.
      Result of enabling correlation tooltips option

    • Stacked: If you have multiple metrics in the visualization, and you want to stack the two charts for better viewing, then check this box.
    • Use Solid Color: This option is checked by default when you use area chart. When you use area chart for visualization, the area that represents the presence of data is covered in solid color. When you uncheck this box, you can visualize the area chart with a lighter color filled in the area. This also helps you to visualize multiple overlapping metrics in area chart mode.
  9. To edit the source data that you have identified for Y axis, click the Actions button Actions icon next to the metric name, and click Edit.

    The Edit Source Data dialog box opens. You can modify the following parameters of the source data:

    • Interval: Select the periodicity at which you want to view the data points.
    • Statistic: Apply any of the statistical functions like Rate, Mean, Sum, Min, Max, Count, 50 Percentile, 90 Percentile, 95 Percentile, or 99 Percentile.
    • Dimension Value: If the data in the metric is collected from multiple dimensions, then you can select one or more of those dimensions using this option.

    Click Save.

  10. Specify the name for the widget in the field provided above the chart.

  11. Click Apply to save the widget, and automatically add it to the dashboard.

    You can now drag your new metric widget to the right location, and modify its size.

    Click Done to save the dashboard.