Updated on 2024-11-25 GMT+08:00

Creating a Dashboard

With a dashboard, different graphs (such as line graphs and digit graphs) are displayed on the same screen, so you can view metric data or log data comprehensively.

You can add key resource metrics to a dashboard and monitor them in real time. You can also compare the same metric of different resources on one screen. In addition, you can add routine O&M metrics to a dashboard so that you can perform routine checks without re-selecting metrics when you open AOM again.

Precautions

  • Preset dashboard templates are listed under System, including the container, cloud service, native middleware, and application templates. Preset dashboards cannot be deleted. Their groups cannot be changed. Dashboard templates cannot be created.
  • Preset container dashboards can be used only after you install kube-prometheus-stack on the Add-ons page of CCE.
  • Preset native middleware dashboards can be used only after you create middleware collection tasks on the UniAgent page.
  • Up to 1000 dashboard groups can be created in a region.
  • Up to 1000 dashboards can be created in a region.
  • A maximum of 30 graphs can be added to a dashboard.
  • A maximum of 200 metric data records can be displayed in a line graph.
  • Only one resource can be displayed in a digit graph.

Creating a Dashboard

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane, choose Dashboard.
  3. Click next to Dashboard to create a dashboard group.
  4. Click Add Dashboard in the upper left corner of the list.
  5. In the displayed dialog box, set parameters.

    Table 1 Parameters for creating a dashboard

    Parameter

    Description

    Dashboard Name

    Name of a dashboard. Enter a maximum of 255 characters. The following special characters are not allowed: "$# %&'+;<=>?\

    Enterprise Project

    Enterprise project.

    • If you have selected All for Enterprise Project on the global settings page, select one from the drop-down list here.
    • If you have already selected an enterprise project on the global settings page, this option will be dimmed and cannot be changed.

    Bind to Application

    Select an application created in CMDB to bind.

    NOTE:

    This configuration item is available only when the application monitoring function is enabled. For details about how to enable this function, see Menu Settings.

    Group Type

    Options: Existing and New.

    • Existing: Select an existing dashboard group from the drop-down list.
    • New: Enter a dashboard group name to create one. Enter a maximum of 255 characters. The following special characters are not allowed: "$# %&'+;<=>?\

  6. Click OK.

Adding a Graph to a Dashboard

After a dashboard is created, you can add graphs to the dashboard:

  1. In the dashboard list, locate the target dashboard.
  2. Go to the dashboard page, and select the Prometheus instance for which you want to add a graph from the drop-down list.
  3. Go to the dashboard page. Click Add Graph or in the upper right corner to add a graph to the dashboard. For details about the graphs that can be added to the dashboard, see Graph Description. The data can be metric, log,. Select a graph as required.

    Table 2 Parameters for adding a graph

    Data Source

    How to Add

    Scenario

    Metric Sources

    See Add a metric graph.

    Monitors metrics of the business layer, application layer, Prometheus middleware, Prometheus running environments, Prometheus cloud services, open-source monitoring systems, Prometheus APIs/SDKs, and custom Prometheus plug-ins.

    Log Sources

    See Add a log graph.

    Monitors business metrics or other log metrics, such as latency, throughput, and errors cleaned based on ELB logs.

    • Add a metric graph. Set parameters by referring to Table 3. Then click Save.
      Figure 1 Adding a metric graph
      Table 3 Adding a metric graph

      Parameter

      Description

      Graph Name

      Name of a graph to distinguish it from other graphs.

      Enter a maximum of 255 characters. The following special characters are not allowed: "$# %&'+;<=>?\

      Data Source

      Click Metric Sources and select metric data as the source.

      Graph Type

      Options: line, digit, top N, table, bar, and digital line.

      Metric List

      Add metrics as required. There are the following ways to add metrics:

      • All metrics: Select desire metrics from all metrics. When you select metrics, you can only enter English keywords to search and only English content is displayed. In this mode, a maximum of 100 metrics can be added.
      • Prometheus statement: Enter a Prometheus command and select your target metric. For details, see Prometheus Statements. In this mode, only one metric can be added.

      Click Add Metric to add up to 100 metric data records.

      NOTE:
      • When All metrics is selected, enter keywords to search for metrics.
      • Condition: Metric monitoring scope. It is in the "key:value" format. You can select a condition from the drop-down list. Select AND or OR to add more conditions for the metric.
      • Group Condition: Aggregate metric data by the specified field and calculate the aggregation result. Options: Not grouped, avg by, max by, min by, and sum by. For example, avg by clusterName indicates that metrics are grouped by cluster name, and the average value of the grouped metrics is calculated and displayed in the graph.
      • Alias: Use a fixed name or variable to display. Format: {{dimension name}}.

        For example, {{host name}}. (Digit graphs, tables, and line graphs do not support aliases.)

      Graph Settings

      On the right of the page, click the down arrow, select a desired graph type from the drop-down list, and set graph parameters (such as the X axis title, Y axis title, and displayed value). For details about the parameters, see Metric Data Graphs.

      Statistic

      Method used to measure metrics. Options: Avg, Min, Max, Sum, and Samples.

      Statistical Period

      Interval at which metric data is collected.

      The available statistical period options vary according to the time range you select. For details, see What Is the Relationship Between the Time Range and Statistical Period.

      Time Range

      Time range in which metric data is collected. Options: Last 30 minutes, Last hour, Last 6 hours, Last day, Last week, and Custom.

      Refresh Frequency

      Interval at which the metric data is refreshed. Options: Refresh manually, 30 seconds auto refresh, 1 minute auto refresh, and 5 minutes auto refresh.

    • Add a log graph. Set parameters by referring to Table 4. Then click Save.
      Figure 2 Adding a log graph
      Table 4 Log graph parameters

      Parameter

      Description

      Graph Name

      Name of a graph to distinguish it from other graphs.

      Enter a maximum of 255 characters. The following special characters are not allowed: "$# %&'+;<=>?\

      Data Source

      Click Log Sources.

      Log Group

      Select a proper log group from the drop-down list box.

      If there is no log group you want to select, click Add Log Group to create one. For details, see Table 6.

      Log Stream

      Select a proper log stream from the drop-down list.

      If there is no log stream you want to select, click Add Log Stream to create one. For details, see Table 6.

      Graph Settings

      1. Select the required field from the structured field list and click next to the field name.
      2. Use the default SQL statements in the log graph or enter related query statements in the SQL statement query area as required.
      3. Specify the statistical period of log data. Options: Last minute, Last 5 minutes, Last 15 minutes, Last hour, Last 6 hours, Last day, Last week, or Custom.
      4. Click Execute Query to query related logs.
      5. By default, log data is displayed based on the graph type you set. You can select a graph type as required.
        • Click to display the current log data in a table.
        • Click to display the current log data in a bar graph.
        • Click to display the current log data in a line graph.
        • Click to display the current log data in a pie graph.
        • Click to display the current log data in a number graph.
        • Click to display the current log data in a digital line graph.
        • Click to display the current log data in a national or provincial map.
        • You can set the display parameters under a graph. For details, see Log Data Graphs.

  4. Click . The graph is successfully added to the dashboard.

More Operations

After a dashboard is created, you can also perform the operations listed in Table 5.

Table 5 Related operations

Operation

Description

Setting column display

Click in the upper right corner of the dashboard list and select or deselect the columns to display.

Adding dashboards to favorites

Locate a dashboard and click in the Operation column.

Moving dashboards to another group

  • Moving a dashboard: Locate a dashboard and choose > Move Group in the Operation column.
  • Moving dashboards in batches: Select dashboards to move. In the displayed dialog box, click Move Group.

Deleting a dashboard

  • Deleting a dashboard: Locate a dashboard and choose > Delete in the Operation column.
  • Deleting dashboards in batches: Select dashboards to delete. In the displayed dialog box, click Delete.

Changing a dashboard group name

  1. In the dashboard list, click a dashboard name.
  2. Go to the dashboard page and click a dashboard name in the upper left corner.
  3. Move the cursor to the target dashboard group and choose > Modify to change the group name.

Deleting a dashboard group

You can delete a dashboard using either of the following methods:

Method 1:

  1. In the dashboard list, click a dashboard name.
  2. Go to the dashboard page and click a dashboard name in the upper left corner.
  3. Move the cursor to the target dashboard group and choose > Delete.
  4. In the displayed dialog box, click OK.

Method 2: In the dashboard group list, locate the target dashboard group and choose > Delete. In the displayed dialog box, click Yes to delete the dashboard group.

Deleting a graph from a dashboard

  1. Click the target dashboard, click in the upper right corner of the dashboard page, move the cursor to the upper right corner of a graph, and choose > Delete.
  2. Click to save the setting.

Relocating a graph on a dashboard

  1. Click the target dashboard, click in the upper right corner of the dashboard page, move the cursor to the target graph, and move it to any position in the dashboard.
  2. Click to save the setting.

Full-screen display

Click the target dashboard and click in the upper right corner of the dashboard page to view the dashboard in full screen.

Exiting the full-screen mode

Move the cursor to the upper part of the screen and click or , or press Esc on the keyboard.

Manual refresh

Click the target dashboard and click in the upper right corner of the dashboard page and manually refresh the current page.

Auto refresh

Click the target dashboard and click the arrow next to in the upper right corner of the dashboard page and enable auto refresh.

Manually refreshing a graph

Click the target dashboard, move the cursor to the upper right corner of a graph, and choose > Refresh to manually refresh the graph.

Modifying a graph

  1. Click the target dashboard, move the cursor to the upper right corner of a graph, and choose > Modify to modify the graph. For details, see Adding a Graph to a Dashboard.
  2. Modify parameters and click OK.
  3. Click in the upper right corner of the dashboard page to save the setting.

Adding alarm rules

  • Adding an alarm rule when adding a graph
    1. Click Add Graph on the page or click in the upper right corner of the page.
    2. After selecting a metric, click in the upper right corner of the metric list to add an alarm rule for the metric. For details, see Creating a Metric Alarm Rule.
  • Adding an alarm rule when modifying a graph
    1. Locate a target dashboard, move the cursor to the upper right corner of a graph, and choose > Modify.
    2. After selecting a metric, click in the upper right corner of the metric list to add an alarm rule for the metric. For details, see Creating a Metric Alarm Rule.

Displaying a graph in full screen

Click the target dashboard, move the cursor to the upper right corner of a graph, and choose > Full Screen.

Exiting the full-screen mode

Move the cursor to the upper part of the screen and click , or choose > Exit Full Screen, or press Esc on the keyboard to exit the full-screen mode.

Rotating dashboards

Click a target dashboard and click in the upper right corner of the dashboard details page. Set full-screen display by referring to Setting the Full-Screen Online Duration.

Setting a dashboard

Click a target dashboard and click in the upper right corner of the dashboard details page. For details, see Adding Variables.

Setting the query time

Select the target dashboard. In the upper right corner of the dashboard page, click the time range next to and select Last 30 minutes, Last hour, Last 6 hours, Last day, Last week, or Custom from the drop-down list. If you select Custom, select a time range in the calendar that is displayed. The time can be accurate to seconds. Then click OK, so that you can query data in the dashboard based on the selected time range.

Exporting a dashboard

Export the metric graph data of a dashboard in JSON format and save it to your local PC for further analysis. You can export a dashboard using either of the following methods:

Method 1: In the dashboard list, locate a dashboard, and choose > Export Dashboard in the Operation column.

Method 2: Click a dashboard to go to its details page and choose > Export Dashboard in the upper right corner.

Importing a dashboard

Import the dashboard data in JSON format from a local PC to AOM for analysis. You can import a dashboard using either of the following methods:

Method 1: On the Dashboard page, click Import Dashboard.

Method 2: In the dashboard group list, locate the group to which the dashboard is to be imported, and choose > Import Dashboard.

Procedure:

  1. Select the JSON dashboard file to be imported, upload it or drag it to the upload area in the Import Dashboard dialog box, and then click OK.
  2. In the dialog box that is displayed, set information such as the dashboard name by referring to Table 1.
  3. Click OK.

Exporting a monitoring report

Select the target dashboard, click in the upper right corner of the Dashboard page, and click Export Line Graph Report to export the line graph as a CSV file for local storage and further analysis..

Table 6 Operations related to log graphs

Operation

Description

Creating a log group

  1. Enter a log group name. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. Do not start with a period or underscore, or end with a period.
  2. Set the log retention duration. The default duration is 7 days. You can set it to up to 30 days. The logs that exceed the retention period will be deleted automatically. You can dump logs to OBS buckets for long-term storage.
  3. Click OK.

Creating a log stream

  1. Enter a log stream name. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. Do not start with a period or underscore, or end with a period.
  2. Click OK.