Dashboards in Monitoring
Dashboards consist of widgets. You can group the widgets in a convenient order, set their size, and add comments. Dashboards allow you to track metric changes in real time and analyze accumulated metrics over time. Metrics on dashboard charts are displayed for a certain time interval, the same for all charts.
The default interval is one day. You can specify a different interval using preset ranges (1h 3h 1d 1w 1mo
). You can also set the start and end of the 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 will be substituted. - Substituting label values in queries.
In the
"cpu.iowait"{folderId="aoe6mk1r3b47********", service="{{ myparm }}", host="*"}
query, theservice
label will get 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 specified Label type parameter for the cluster
label which takes the prod
, preprod-1
, preprod-2
, and testing
values.
Filtering settings and result:
- The
cluster=*prod*
filter will limit parameter values to the list ofprod
andpreprod-1
values. - The
cluster=preprod-|preprod-2
filter will limit the values to the list ofpreprod-1
andpreprod-2
values. - The
cluster=testing
filter will limit the values to a single value,testing
.
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. - The dashboard has the Label type parameters specified for the
cluster
andaccount
labels.
Result:
- The only possible values of the
cluster
parameter will beprod
andpreprod
. Thetesting
value will be excluded as not matching thecluster=*prod*
rule. - The only possible values of the
account
parameter will beprodaccount
,preprodaccount
, andmultiaccount
. Thetestingaccount
value will be excluded as there is no metric with a combination ofaccount="testingaccount"
andcluster
labels matching thecluster=*prod*
rule (formultiaccount
, there is such a combination).