Help Center/ Log Tank Service/ User Guide/ Log Visualization/ Visualizing Logs in Dashboards/ Creating a Dashboard
Updated on 2024-11-18 GMT+08:00
View PDF
Share

Creating a Dashboard

Dashboards serve as data visualization tools that summarize and display key performance metrics, important data, and analysis results. They offer a comprehensive overview of service or system statuses.

LTS provides various dashboard templates to visualize log data or retain statistical charts derived from queries and analyses.

Currently, this function is available to all users in regions CN South-Guangzhou, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN-Hong Kong, CN Southwest-Guiyang1, AP-Singapore, CN North-Beijing1, and AP-Bangkok. It is also available to whitelisted users in regions CN South-Shenzhen, ME-Riyadh, and AP-Jakarta.

Prerequisites

  • Logs have been collected.
  • Logs have been structured. For details, see Log Structuring.

Restrictions

  • Up to 100 dashboards can be created in an account.
  • Up to 100 charts can be created for a log stream.
  • Up to 50 charts can be added to a dashboard.

Creating a Dashboard

  1. Log in to the LTS console. In the navigation pane, choose Dashboards.
  2. Click . In the Add Dashboard Group dialog box, enter a group name.

    A group name can contain up to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Do not start or end with a period or underscore (_).

  3. Click OK.
  4. Click Add Dashboard. On the displayed page, set parameters by referring to Table 1.

    Table 1 Parameters for creating a dashboard

    Parameter

    Description

    Dashboard Name

    Enter a unique name to differentiate your dashboard from other dashboards in the log stream.

    The value can contain up to 255 characters and cannot start or end with a period (.). Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

    Enterprise Project Name

    Select the required enterprise project. The default value is default. You can click View Enterprise Projects to view all enterprise projects.

    Add to Dashboard Group

    Add the created dashboard to a group for management.

    If this parameter is disabled, the created dashboard will be added to the system's default group.

    If this parameter is enabled, the created dashboard will be added to a group based on the group type you selected.

    • Existing: Select an existing dashboard group.
    • Create Group: Enter a dashboard group name to create one.

    Lite Mode

    Set whether to display the dashboard page in lite mode.

    • If you enable this mode, the buttons for editing and deleting the dashboard, adding filters, and drilling down charts will not be displayed on the dashboard.
    • If you disable this mode, the buttons for editing and deleting the dashboard and adding filters will be displayed on the dashboard.

    Add Chart

    Custom: Select log streams' charts to add to the dashboard.

    1. Click Add Chart under Custom.
    2. Select one or more log streams, select one or more charts by clicking their check box (), and click OK. On the dashboard details page displayed, adjust the charts as required and click Save.
    3. If there are no suitable charts or no charts at all in a log stream, click Create Chart to create one.

    Using Dashboard Templates: You can select a custom template (extracted from a created dashboard) or a system template (LTS's built-in template, which cannot be modified).

    1. In the Add Chart area, click Use Dashboard Templates.
    2. Select a dashboard template and click Next. Select one or more log streams by clicking , and click OK.

  5. The created dashboard will be displayed in the dashboard list.

    • Click Edit in the Operation column of the dashboard to change the dashboard name and lite mode.
    • Click Move in the Operation column of the dashboard to change the group.
    • Click Delete in the Operation column of the dashboard to delete it.

Creating a Chart for a Dashboard

  1. In the lower part of the dashboard directory, select a dashboard group and click the name of the target dashboard to access its details page.
  2. Click in the upper right corner. On the displayed page, select a log stream. Then click Create Chart.
  3. On the Add Chart page displayed, click Create, set parameters by referring to Table 2, and click OK.

    Table 2 Creating a chart

    Parameter

    Description

    Chart Name

    Enter a unique name to differentiate your chart from other charts in the log stream.

    Enter 1 to 64 characters, including only letters, digits, hyphens (-), underscores (_), spaces, brackets, and periods (.). Do not start or end with a period or space.

    SQL Statement
    • The default statement is SELECT *, which is used to query structured log data in the log stream.
    • For details about SQL statements, see SQL Analysis Syntax.

    Chart Type

    The following charts are available:

    Add to Dashboard
    • If you enable this option, select one or more dashboards to add the chart to them.
    • If you disable this option, the chart will not be displayed on any dashboard.

  4. Click OK.

Related Operations

After a dashboard is created, click the dashboard name to go to the details page. You can edit and remove its chart, and adjust chart positions. For details, see Table 3.

Table 3 Related operations

Operation

Description

Edit chart

Move the cursor to the upper right corner of a chart, click , and select Edit from the drop-down list to edit the chart. For details, see Analyzing Logs in LTS.

Remove chart

Move the cursor to the upper right corner of a chart, click , select Remove from the drop-down list, and click Save.

Relocate chart

Move the cursor to a chart, drag the chart to the desired location on the dashboard, and click Save.

Resize chart

Move the cursor to the lower right corner of a chart, drag the corner to adjust the chart size, and click Save.

Modify filter

Move the cursor to the upper right corner of a filter, click , and select Modify from the drop-down list. On the displayed page, edit the filter by referring to Adding a Filter.

Copy filter

Move the cursor to the upper right corner of a filter, click , and select Copy from the drop-down list. On the displayed page, click OK to copy the filter.

Delete filter

Move the cursor to the upper right corner of a filter, click , and select Delete from the drop-down list. In the displayed Delete Filter dialog box, click OK to delete the filter.

Resize filter

Move the cursor to the lower right corner of a filter, drag the corner to adjust the filter size, and click Save.

Enable auto refresh

Click in the upper right corner, and enable auto refresh with a specified interval to refresh the data in all charts. The interval can be 1, 5, and 15 minutes.

Manually refresh

Select a dashboard and click to manually refresh it.

View dashboard in full screen

Select a dashboard and click to view the dashboard in full screen. In the full-screen mode, you can select Stay Logged In so that your account will not be logged out after a period of inactivity.

Exit full screen of dashboard

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

View chart in full screen

Select a dashboard and click Cancel to exit the editing mode. Move the cursor to the upper right corner of a chart, click , and select Full Screen from the drop-down list.

Exit full screen of chart

Move the cursor to the upper part of the screen and click , or click and select Exit Full Screen from the drop-down list, or press Esc on the keyboard.

Manually refresh chart

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select Refresh from the drop-down list. Alternatively, in full-screen mode, click and select Refresh from the drop-down list.

Set time range

Select a dashboard and click the drop-down list box before .

There are three types of time range: relative time from now, relative time from last, and specified time. Select a time range as required.
NOTE:
  • From now: queries log data generated in a time range that ends with the current time, such as the previous 1, 5, or 15 minutes. For example, if the current time is 19:20:31 and 1 hour is selected as the relative time from now, the charts on the dashboard display the log data that is generated from 18:20:31 to 19:20:31.
  • From last: queries log data generated in a time range that ends with the current time, such as the previous 1 or 15 minutes. For example, if the current time is 19:20:31 and 1 hour is selected as the relative time from last, the charts on the dashboard display the log data that is generated from 18:00:00 to 19:00:00.
  • Specified: queries log data that is generated in a specified time range.

View chart details

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select View Details from the drop-down list.

Add alarm rules

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select Add Alarm Rule from the drop-down list.

Copy

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select Copy from the drop-down list.

Copy to other dashboards

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select Copy to Other Dashboards from the drop-down list.

Copy statement

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select Copy Statement from the drop-down list.

Export chart data

Select a dashboard, move the cursor to the upper right corner of a chart, click , and select Export Chart Data from the drop-down list.