Dashboards in Monitoring
Dashboards are sets of widgets: charts, text blocks, and titles. Metrics on dashboard charts are displayed for a specific interval that is shared by all charts.
The default interval is one day. The interval can be set using preset ranges (1h 3h 1d 1w 1mo
). You can also set the beginning and the end interval.
To set the time interval more precisely, you can use the timeline located above the dashboard.
Yandex Cloud users can use service dashboards containing preset widgets with metrics reporting the status of cloud resources. Service dashboards are created automatically.
Dashboard parameters
Parameters allow you to create dashboards with customizable interactive content. For example, a dashboard presenting aggregated VM status information can be parameterized using the VM ID.
Parameters are displayed as drop-down menus above dashboard widgets. When you select a parameter value, the dashboard is updated and the selected value is substituted in data queries. How to add a dashboard parameter.
The following dashboard parameter types are used:
- Label: Parameter taking a set of values of the specified label.
- Custom: Parameter taking a set of fixed comma-separated values.
- Text: Parameter taking the single value specified in the text field.
For parameters of the Label and Custom type, the Multivalue setting is available to select multiple parameter values at the same time.
For all parameter types, you can set the Default value that will be used when loading a dashboard in the Yandex Monitoring web interface.
Parameter substitution
Dashboard parameter values are used in widget headings and queries to metrics to filter label values. Parameter values are substituted using mustache template
Note
You can only use parameter value substitution in label values when making queries to metrics.
Examples of parameter value substitution
- Substituting values in widget headings.
In the
CPU usage on {{host}}
widget heading, thehost
parameter value is substituted. - Substituting label values in queries.
In the
"cpu.iowait"{folderId="aoe6mk1r3b47********", service="{{myparm}}", host="*"}
query, theservice
label value is substituted with themyparm
parameter value.
Substituting parameter values in query strings when adding a widget to the dashboard looks like this:
Label value filter
The label value filter enables you to limit the list of possible parameter values of the Label type. The filter specifies labels and their values. The filter is applied to all parameters of the Label type at the same time.
Examples of filtering label values
Let's assume a dashboard has a Label type parameter set for a cluster
label that takes the values prod
, preprod-1
, preprod-2
, and testing
.
Filtering settings and result:
- The
cluster=*prod*
filter limits parameter values to the list ofprod
andpreprod-1
values. - The
cluster=preprod-1|preprod-2
filter limits the values with the list ofpreprod-1
andpreprod-2
. - The
cluster=testing
filter limits the values to a singletesting
value.
Below is a more complex example. Let's say the system has the following metrics:
usage{cluster="prod", account="prodaccount"}
;usage{cluster="preprod", account="preprodaccount"}
;usage{cluster="testing", account="testingaccount"}
;usage{cluster="prod", account="multiaccount"}
;usage={cluster="testing", account="multiaccount"}
.
Filtering settings:
- The filter contains the
cluster=*prod*
value. - A dashboard has Label type parameters set for the
cluster
andaccount
labels.
Result:
- Possible values of the
cluster
parameter will be limited toprod
andpreprod
. Thetesting
value will be excluded as not matching thecluster=*prod*
rule. - Possible values of the
account
parameter will be limited toprodaccount
,preprodaccount
, andmultiaccount
. Thetestingaccount
value will be excluded as there is no metric with a combination ofaccount="testingaccount"
andcluster
labels matching thecluster=*prod*
rule (while this combination exists formultiaccount
).