Manage custom metric dashboards

In the control panel, you can create custom dashboards and configure widgets on them to visualize metrics of Servercore products and services without using third-party applications. Learn more in the Custom dashboards section

Create dashboard

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Click Create dashboard.

4. In the Source field, select the projects whose metrics will be displayed on the dashboard.

5. Select locations whose metrics will be displayed on the dashboard.

6. Enter a dashboard name. The maximum length is 255 characters.

7. Optional: enter a dashboard description. The maximum length is 255 characters.

8. Add variables (labels and their values) to filter data on dashboard widgets.

   8.1. In the Variables section, click .

   8.2. Select a label.

   8.3. Select the label values to display on the dashboard. Select the All values checkbox to select all current and future label values.

   8.4. To add multiple labels and values, repeat steps 8.1–8.3.

   Variables will be applied to dashboard widgets for which, during addition in step 8, you selected the Use dashboard variables type. If the Apply custom label values filter type is selected for a widget and custom variables are configured, the dashboard variables will not be applied to the widget.

9. Click Create dashboard.

View dashboard

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. Configure dashboard filters that will be applied to the added widgets:

   4.1. In the Source field, select the projects whose metrics you want to view. Only projects accessible to the user are available in the list. Learn more in the Manage access to metrics section.

   4.2. In the Location field, select the locations where you want to view metrics. Learn more about available service locations in the Metrics availability in locations instructions.

   4.3. Optional: select the variable values to display on the dashboard. By default, all values are selected.

   4.4. Optional: select a preset range or specify the period for which you need metrics. By default, 1 day is selected.

   4.5. Optional: select UTC time or Local time for the displayed metrics time.

   4.6. Click Run.

5. Optional: add the widget legend display to the graph. To do this, in the widget's menu, click Show legend.

6. Optional: to inspect a section of the chart in more detail, select it. The chart will zoom in, and the time range will update to the selected section's time range.

7. Save the filters you configured. To do this, click .

Edit dashboard settings

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. In the dashboard's menu, select Edit settings.

4. Modify the required dashboard settings.

5. Click Save changes.

Copy dashboard

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. In the dashboard's menu, select Make a copy.

4. If necessary, modify the settings of the copied dashboard.

5. Click Create dashboard.

Delete dashboard

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. In the dashboard's menu, select Delete dashboard.

4. Enter the dashboard name.

5. Click Delete.

Manage dashboard widgets

Add widget

The maximum number of widgets you can add to a dashboard is 30. You can add up to five queries to each widget.

Query builder

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. Click Add widget.

5. Enter a widget name.

6. Click Add query builder.

7. Select a metric for the query.

8. Select a filter type:

   • Use dashboard variables — the widget data will use the variables that you added when creating the dashboard in step 8;
   • Apply custom label values — widget data will use variables different from the dashboard filters.

   8.1. If you selected the Apply custom label values filter type, click to add a variable.

   8.2. Select a label and its values to filter.

   8.3. If you need to add more than one filter, repeat steps 8.1–8.2. Multiple filters will work via logical AND.

   8.4. Click Save filter.

9. Optional: change the legend that will be displayed for the query on the widget chart.

10. Click to run the query and display metric data on the widget graph.

11. If you need to add multiple queries, repeat steps 6–10.

12. Optional: customize the chart view.

    12.1. Select the chart type.

    12.2. Select a unit of measurement for the Y axis.

    12.3. If you selected the Value chart type in step 12.1, you can specify value thresholds. To do this, turn on the Thresholds toggle switch and specify thresholds.

13. Click Save.

PromQL query

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. Click Add widget.

5. Enter a widget name.

6. Click Add PromQL query.

7. Select a namespace for the query.

8. Enter a PromQL query. Learn more about the basic syntax of such queries in the Querying basics guide of Prometheus documentation.

9. Optional: change the legend that will be displayed for the query on the widget chart.

10. Click to run the query and display metric data on the widget graph. Query examples:

    • amount of data transferred over the network for the period:

      sum(avg_over_time(network_receive_bits_rate[1h])) * 3600 / 8 / 1024 / 1024

    • average CPU utilization by project:

      avg by (project_name) (
          cpu_usage_ratio * on (server_uuid) group_left(project_name) server_meta_info
      )

11. If you need to add multiple queries, repeat steps 6–10. You can add up to five queries per widget.

12. Optional: customize the chart view.

    12.1. Select the chart type.

    12.2. Select a unit of measurement for the Y axis.

    12.3. If you selected the Value chart type in step 12.1, you can specify value thresholds. To do this, turn on the Thresholds toggle switch and specify thresholds.

13. Click Save.

Edit widget settings

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. In the widget's menu, select Edit.

5. Modify the required widget settings.

6. Click Save to apply the changes.

Change widget position

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. Drag the widget to change its position on the dashboard.

5. Optional: resize the widget. To do this, click and drag the bottom corner of the widget.

6. Save the changes on the dashboard. To do this, click .

Delete widget

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. In the widget's menu, select Delete widget.

5. Click to save the changes on the dashboard.

Manage dashboard sections

Add section

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. Click Add section.

5. Optional: enter a section name.

6. Drag widgets into the section.

7. Click to save the changes on the dashboard.

Delete section

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. In the section's menu, select:

   • Delete section only — the section widgets will be ungrouped, but not deleted;
   • Delete section with widgets — the section will be deleted along with the widgets added to it.

5. Click to save the changes on the dashboard.

Add text note

1. In the Control Panel, in the top menu, click Products and select Metrics.

2. Go to Dashboards → My dashboards tab.

3. Open the dashboard page.

4. Click .

5. Select the text size.

6. Enter text.

7. Click .

8. Click to save the changes on the dashboard.