Adding Variables

Updated on 2025-01-07 GMT+08:00

View PDF

You can add variables to customize filters when viewing or adding graphs on the Dashboard page.

Log in to the AOM 2.0 console.
In the navigation pane, choose Dashboard.
Select a desired dashboard and click in the upper right corner of the Dashboard page. The Variable Settings page is displayed.

Click Add Variable and set parameters by referring to Table 1.

**Table 1** Parameters for adding variables
Parameter	Description
Variable Name	Name of a variable. Enter up to 255 characters and do not start or end with an underscore (_). Only digits, letters, and underscores are allowed.
Type	Type of the variable. Only Query is supported.
Alias	Alias of the variable. Enter up to 255 characters and do not start or end with an underscore (_) or hyphens (-). Only digits, letters, hyphens, and underscores are allowed. If you set an alias, it will be preferentially displayed.
Description	Description of the variable.
Data Source	Source of the data. Select a data source on the Dashboard page. It is dimmed here and cannot be selected. You can select a default or custom Prometheus instance. By default, the default Prometheus instance is selected.
Refresh Mode	Filter refresh mode. Only On dashboard load is supported, which means refreshing filters when your dashboard is refreshed.
Metric	Name of a metric. You can select metrics of the selected Prometheus instance.
Display Field	Displayed in a filter drop-down list on a dashboard.
Value	Value of the display field.
Conditions	Dimension name and value. You can set multiple conditions for the same metric.
Allow multiple values	Whether multiple values can be selected. By default, this function is disabled. If it is enabled, you can select multiple values for your custom filter.
Include "All"	Whether the All option is available. By default, this function is disabled. If it is enabled, the All option will be added for your custom filter.

Click Save to add the variable.

The new variable will be displayed as a filter on the dashboard page and the page for adding a graph. You can click the filter and select a desired value from the drop-down list.

Figure 1 Checking filters

After the variable is added, you can perform the operations listed in Table 2 if needed.

**Table 2** Related operations
Parameter	Description
Searching for a variable	You can search for variables by name. Enter a keyword in the search box above the variable list and click to search.
Editing a variable	Click in the Operation column of the target variable. For details, see Table 1.
Deleting a variable	Click in the Operation column of the target variable. In the displayed dialog box, click Yes.