Table of Contents
27 Top items
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Top items widget in dashboard.create and dashboard.update methods.
Widget fields properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the Top items widget, please refer to the parameter behavior outlined in the tables below.
Parameters
The following parameters are supported for the Top items widget.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - (default) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
|
| Host groups | 2 | groupids.0 | Host group ID. Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name. This parameter is not supported if configuring the widget on a template dashboard. |
|
| Host groups (Widget) | 1 | groupids._reference | Instead of Host group ID:ABCDE._hostgroupids - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for host groups.This parameter is not supported if configuring the widget on a template dashboard. |
|
| Hosts | 3 | hostids.0 | Host ID. Note: To configure multiple hosts, create a dashboard widget field object for each host with an incremented number in the property name. For multiple hosts, the parameter Host groups must either be not configured at all or configured with at least one host group that the configured hosts belong to. This parameter is not supported if configuring the widget on a template dashboard. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Instead of Host ID:DASHBOARD.hostids - set the Host selector as the data source for hosts;ABCDE._hostids - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for hosts.This parameter is not supported if configuring the widget on a template dashboard. |
|
| Host tags | ||||
| Evaluation type | 0 | host_tags_evaltype | 0 - (default) And/Or; 2 - Or. This parameter is not supported if configuring the widget on a template dashboard. |
|
| Tag name | 1 | host_tags.0.tag | Any string value. Note: The number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Host tags This parameter is not supported if configuring the widget on a template dashboard. |
|
| Operator | 0 | host_tags.0.operator | 0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. Note: The number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Host tags This parameter is not supported if configuring the widget on a template dashboard. |
|
| Tag value | 1 | host_tags.0.value | Any string value. Note: The number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Host tags This parameter is not supported if configuring the widget on a template dashboard. |
|
| Layout | 0 | layout | 0 - (default) Horizontal; 1 - Vertical. |
|
| Show problems | 0 | show_problems | 0 - All; 1 - (default) Unsuppressed; 2 - None. |
|
| Items (see below) | ||||
Advanced configuration
The following advanced configuration parameters are supported for the Top items widget.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Host ordering | ||||
| Order by | 0 | host_ordering_order_by | 0 - (default) Host name; 3 - Item value. |
|
| Item patterns | 1 | host_ordering_item.0 | Item name or pattern (e.g., "*: Number of processed *values per second"). Note: To configure multiple item patterns, create a dashboard widget field object for each item pattern with an incremented number in the property name. When configuring the widget on a template dashboard, only the patterns for items configured on the template should be set. Parameter behavior: - required if Order by is set to "Item value" |
|
| Order | 0 | host_ordering_order | 2 - (default) Top N; 3 - Bottom N. |
|
| Limit | 0 | host_ordering_limit | Possible values range from 1-100. Default: 10. |
|
| Item ordering | ||||
| Order by | 0 | item_ordering_order_by | 1 - Host; 2 - Item name; 3 - (default) Item value. |
|
| Host patterns | 1 | item_ordering_host.0 | Host name or pattern. Note: To configure multiple host patterns, create a dashboard widget field object for each host pattern with an incremented number in the property name. Parameter behavior: - required if Order by is set to "Host" |
|
| Order | 0 | item_ordering_order | 2 - (default) Top N; 3 - Bottom N. |
|
| Limit | 0 | item_ordering_limit | Possible values range from 1-100. Default: 10. |
|
Columns
The first number in the property name (e.g. columns.0.items.0, columns.0.item_tags_evaltype) represents the particular column, while the second number, if present, represents the configured entity (e.g. item pattern, tag).
| Parameter | type | name | value | |
|---|---|---|---|---|
| Item patterns | 1 | columns.0.items.0 | Item name or pattern (e.g., "*: Number of processed *values per second"). Note: To configure multiple item patterns, create a dashboard widget field object for each item pattern with an incremented second number in the property name. When configuring the widget on a template dashboard, only the patterns for items configured on the template should be set. Parameter behavior: - required |
|
| Item tags | ||||
| Evaluation type | 0 | columns.0.item_tags_evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | columns.0.item_tags.0.tag | Any string value. Note: The second number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Item tags |
|
| Operator | 0 | columns.0.item_tags.0.operator | 0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. Note: The second number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Item tags |
|
| Tag value | 1 | columns.0.item_tags.0.value | Any string value. Note: The second number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Item tags |
|
| Base color | 1 | columns.0.base_color | Hexadecimal color code (e.g. FF0000). |
|
| Display value as | 0 | columns.0.display_value_as | 1 - (default) Numeric; 2 - Text. |
|
| Display | 0 | columns.0.display | 1 - (default) As is; 2 - Bar; 3 - Indicators; 6 - Sparkline. |
|
| Min | 1 | columns.0.min | Any numeric value. Suffixes (e.g. "1d", "2w", "4K", "8G") are supported. Parameter behavior: - supported if Display value as is set to "Numeric" and Display is set to "Bar" or "Indicators" |
|
| Max | 1 | columns.0.max | Any numeric value. Suffixes (e.g. "1d", "2w", "4K", "8G") are supported. Parameter behavior: - supported if Display value as is set to "Numeric" and Display is set to "Bar" or "Indicators" |
|
| Sparkline | ||||
| Width | 0 | columns.0.sparkline.width | Possible values range from 0-10. Default: 1. Parameter behavior: - supported if Display is set to "Sparkline" |
|
| Fill | 0 | columns.0.sparkline.fill | Possible values range from 0-10. Default: 3. Parameter behavior: - supported if Display is set to "Sparkline" |
|
| Color | 1 | columns.0.sparkline.color | Hexadecimal color code (e.g. FF0000).Default: 42A5F5.Parameter behavior: - supported if Display is set to "Sparkline" |
|
| Time period | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - set the Time period selector as the data source;ABCDE._timeperiod - set a compatible widget (with its reference parameter equal to ABCDE) as the data source.Default: DASHBOARD._timeperiodAlternatively, you can set the time period only in the From and To parameters. Parameter behavior: - supported if Display is set to "Sparkline" |
|
| From | 1 | columns.0.sparkline.time_period.from | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Display is set to "Sparkline" |
|
| To | 1 | columns.0.sparkline.time_period.to | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Display is set to "Sparkline" |
|
| History data | 0 | columns.0.sparkline.history | 0 - (default) Auto; 1 - History; 2 - Trends. Parameter behavior: - supported if Display is set to "Sparkline" |
|
| Thresholds | ||||
| Color | 1 | columns.0.thresholds.0.color | Hexadecimal color code (e.g. FF0000).Parameter behavior: - supported if Display value as is set to "Numeric" |
|
| Threshold | 1 | columns.0.thresholds.0.threshold | Any numeric value. Suffixes (e.g. "1d", "2w", "4K", "8G") are supported. Parameter behavior: - supported if Display value as is set to "Numeric" |
|
| Highlights | ||||
| Highlight | 1 | columns.0.highlights.0.color | Hexadecimal color code (e.g. FF0000).Parameter behavior: - supported if Display value as is set to "Text" |
|
| Threshold | 1 | columns.0.highlights.0.pattern | Any regular expression. Parameter behavior: - supported if Display value as is set to "Text" |
|
| Decimal places | 0 | columns.0.decimal_places | Possible values range from 0-10. Default: 2. |
|
| Advanced configuration | ||||
| Aggregation function | 0 | columns.0.aggregate_function | If Display value as is set to "Numeric": 0 - (default) not used; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. If Display value as is set to "Text": 0 - (default) not used; 4 - count; 6 - first; 7 - last. |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - set the Time period selector as the data source;ABCDE._timeperiod - set a compatible widget (with its reference parameter equal to ABCDE) as the data source.Default: DASHBOARD._timeperiodAlternatively, you can set the time period only in the From and To parameters. Parameter behavior: - supported if Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 1 | columns.0.time_period.from | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Time period is not set and Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last" |
|
| To | 1 | columns.0.time_period.to | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Time period is not set and Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last" |
|
| History data | 0 | columns.0.history | 0 - (default) Auto; 1 - History; 2 - Trends. Parameter behavior: - supported if Display value as is set to "Numeric" |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Top items widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Top items widget
Configure a Top items widget that displays data for host "10084" and only for items for which the tag with the name "component" contains the value "cpu". In addition, display the data with hosts located at the top and use a colored gauge bar for cell representation.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: