Table of Contents
24 Top triggers
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Top triggers widget in dashboard.create and dashboard.update methods.
Parameters
The following parameters are supported for the Top triggers widget.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - (default) No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - 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. Parameter Host groups not available when 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. Parameter Hosts not available when configuring the widget on a template dashboard. |
|
| Problem | 1 | problem | Problem event name (case insensitive, full name or part of it). | |
| Severity | 0 | severities.0 | Trigger severities. 0 - Not classified; 1 - Information; 2 - Warning; 3 - Average; 4 - High; 5 - Disaster. Default: 1, 2, 3, 4, 5 (all enabled). Note: To configure multiple values, create a dashboard widget field object for each value with an incremented number in the property name. |
|
| Problem tags (the number in the property name (e.g. tags.0.tag) references tag order in the tag evaluation list) | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | tags.0.tag | Any string value. Parameter behavior: - required if configuring Problem tags |
|
| Operator | 0 | tags.0.operator | 0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. Parameter behavior: - required if configuring Problem tags |
|
| Tag value | 1 | tags.0.value | Any string value. Parameter behavior: - required if configuring Problem tags |
|
| Time period | ||||
| Time period | 1 | 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. |
|
| From | 1 | 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 From not available if Time period is set to " DASHBOARD._timeperiod or "ABCDE._timeperiod". |
|
| To | 1 | 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 From not available if Time period is set to " DASHBOARD._timeperiod or "ABCDE._timeperiod". |
|
| Trigger limit | 0 | show_lines | Valid values range from 1-100. Default: 10. |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Top triggers widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Top triggers widget
Configure a Top triggers widget that displays the top 5 triggers for host group "4" with the count of all problems for each trigger. The widget displays only triggers that have severities "Warning", "Average", "High", or "Disaster", and problems that have a tag with the name "scope" that contains values "performance" or "availability", or "capacity".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "toptriggers",
"name": "Top triggers",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 0,
"name": "severities.0",
"value": 2
},
{
"type": 0,
"name": "severities.1",
"value": 3
},
{
"type": 0,
"name": "severities.2",
"value": 4
},
{
"type": 0,
"name": "severities.3",
"value": 5
},
{
"type": 1,
"name": "tags.0.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "performance"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 0
},
{
"type": 1,
"name": "tags.1.value",
"value": "availability"
},
{
"type": 1,
"name": "tags.2.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.2.operator",
"value": 0
},
{
"type": 1,
"name": "tags.2.value",
"value": "capacity"
},
{
"type": 0,
"name": "show_lines",
"value": 5
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: