Sidebar

8 Graph

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Graph widget in dashboard.create and dashboard.update methods.

Parameters

The following parameters are supported for the Graph 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.

Data set

The following parameters are supported for configuring a Data set.

The first number in the property name (e.g. ds.hosts.0.0, ds.items.0.0) represents the particular data set, while the second number, if present, represents the configured host or item.

Parameter type name value
Host pattern
(required)
1 ds.hosts.0.0 Host name or pattern (e.g. Zabbix*).
Item pattern
(required)
1 ds.items.0.0 Item name or pattern (e.g. *: Number of processed *values per second).
Color 1 ds.color.0 Hexadecimal color code (e.g. FF0000).

Default: FF465C.
Draw 0 ds.type.0 0 - (default) Line;
1 - Points;
2 - Staircase;
3 - Bar.
Width 0 ds.width.0 Valid values range from 1-10.

Default: 1.

Parameter Width not available if Draw is set to "Points" or "Bar".
Point size 0 ds.pointsize.0 Valid values range from 1-10.

Default: 3.

Parameter Point size not available if Draw is set to "Line", "Staircase" or "Bar".
Transparency 0 ds.transparency.0 Valid values range from 1-10.

Default: 5.
Fill 0 ds.fill.0 Valid values range from 1-10.

Default: 3.

Parameter Fill not available if Draw is set to "Points" or "Bar".
Missing data 0 ds.missingdatafunc.0 0 - (default) None;
1 - Connected;
2 - Treat as 0.

Parameter Missing data not available if Draw is set to "Points" or "Bar".
Y-axis 0 ds.axisy.0 0 - (default) Left;
1 - Right.
Time shift 1 ds.timeshift.0 Valid time string (e.g. 3600, 1h, etc.).
You may use time suffixes. Negative values are also allowed.

Default: "" (empty).
Aggregation function 0 ds.aggregate_function.0 0 - (default) none;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Aggregation interval 1 ds.aggregate_interval.0 Valid time string (e.g. 3600, 1h, etc.).
You may use time suffixes.

Default: 1h.
Aggregate 0 ds.aggregate_grouping.0 0 - (default) Each item;
1 - Data set.

Parameter Aggregate not available if Aggregation function is set to "none".

Display options

The following parameters are supported for configuring Display options.

Parameter type name value
History data selection 0 source 0 - (default) Auto;
1 - History;
2 - Trends.

Time period

The following parameters are supported for configuring Time period.

Parameter type name value
Set custom time period 0 graph_time 0 - (default) Disabled;
1 - Enabled.
From 1 time_from Valid time string in format YYYY-MM-DD hh:mm:ss.
Relative time period values (now, now/d, now/w-1w, etc.) are also supported.

Default: now-1h.
To 1 time_to Valid time string value in format YYYY-MM-DD hh:mm:ss.
Relative time period values (now, now/d, now/w-1w, etc.) are also supported.

Default: now.

Axes

The following parameters are supported for configuring Axes.

Parameter type name value
Left Y 0 lefty 0 - Disabled;
1 - (default) Enabled.

Parameter available if Y-axis (in Data set configuration) is set to "Left".
Right Y 0 righty 0 - (default) Disabled;
1 - Enabled.

Parameter available if Y-axis (in Data set configuration) is set to "Right".
Min 1 lefty_min Any numeric value.

Default: "" (empty).
righty_min
Max 1 lefty_max Any numeric value.

Default: "" (empty).
righty_max
Units (type) 0 lefty_units 0 - (default) Auto;
1 - Static.
righty_units
Units (value) 1 lefty_static_units Any string value.

Default: "" (empty).
righty_static_units
X-Axis 0 xaxis 0 - Disabled;
1 - (default) Enabled.

Legend

The following parameters are supported for configuring Legend.

Parameter type name value
Show legend 0 legend 0 - Disabled;
1 - (default) Enabled.
Number of rows 0 legend_lines Valid values range from 1-5.

Default: 1.

Problems

The following parameters are supported for configuring Problems.

Parameter type name value
Show problems 0 show_problems 0 - (default) Disabled;
1 - Enabled.
Selected items only 0 graph_item_problems 0 - Disabled;
1 - (default) Enabled.
Problem hosts 1 problemhosts.0 Host name.

Note: The number in the property name references the configured host.
To configure multiple hosts, create a dashboard widget field object for each host.
Severity 0 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.
Problem 1 problem_name Problem event name (case insensitive, full name or part of it).
Tags (the number in the property name (e.g. tags.tag.0) references tag order in the tag evaluation list)
Evaluation type 0 evaltype 0 - (default) And/Or;
2 - Or.
Tag name 1 tags.tag.0 Any string value.

Parameter Tag name required if configuring Tags.
Operator 0 tags.operator.0 0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.

Parameter Operator required if configuring Tags.
Tag value 1 tags.value.0 Any string value.

Parameter Tag value required if configuring Tags.

Overrides

The following parameters are supported for configuring Overrides.

The first number in the property name (e.g. or.hosts.0.0, or.items.0.0) represents the particular data set, while the second number, if present, represents the configured host or item.

Parameter type name value
Host pattern
(required)
1 or.hosts.0.0 Host name or pattern (e.g. Zabbix*).
Item pattern
(required)
1 or.items.0.0 Item name or pattern (e.g. *: Number of processed *values per second).
Base color 1 or.color.0 Hexadecimal color code (e.g. FF0000).
Width 0 or.width.0 Valid values range from 1-10.
Draw 0 or.type.0 0 - Line;
1 - Points;
2 - Staircase;
3 - Bar.
Transparency 0 or.transparency.0 Valid values range from 1-10.
Fill 0 or.fill.0 Valid values range from 1-10.
Point size 0 or.pointsize.0 Valid values range from 1-10.
Missing data 0 or.missingdatafunc.0 0 - None;
1 - Connected;
2 - Treat as 0.
Y-axis 0 or.axisy.0 0 - Left;
1 - Right.
Time shift 1 or.timeshift.0 Valid time string (e.g. 3600, 1h, etc.).
You may use time suffixes. Negative values are allowed.

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the Graph widget. For more information on configuring a dashboard, see dashboard.create.

Configuring a Graph widget

Configure a Graph widget in the following way:

  • 4 data sets for a total of 9 items on 1 host.
  • Each data set consists of a line that has a custom color, width, transparency, and fill.
  • Data set 4 has a configured aggregation.
  • Data in the graph are displayed for a time period of the last 3 hours.
  • Problems in the graph are displayed only for the configured items.
  • Graph has two Y axes of which the right Y axis displays values only for Data set 4.
  • Graph legend displays configured items in 2 rows.

Request:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "svggraph",
                               "name": "Graph",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 1,
                                       "name": "ds.hosts.0.0",
                                       "value": "Zabbix server"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.items.0.0",
                                       "value": "Zabbix server: Utilization of poller data collector processes, in %"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.color.0",
                                       "value": "FF0000"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.width.0",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.transparency.0",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.fill.0",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.hosts.1.0",
                                       "value": "Zabbix server"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.items.1.0",
                                       "value": "Zabbix server: Utilization of trapper data collector processes, in %"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.color.1",
                                       "value": "BF00FF"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.width.1",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.transparency.1",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.fill.1",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.hosts.2.0",
                                       "value": "Zabbix server"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.items.2.0",
                                       "value": "Zabbix server: Utilization of history syncer internal processes, in %"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.color.2",
                                       "value": "0040FF"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.width.2",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.transparency.2",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.fill.2",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.hosts.3.0",
                                       "value": "Zabbix server"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.items.3.0",
                                       "value": "*: Number of processed *values per second"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.color.3",
                                       "value": "000000"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.transparency.3",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.fill.3",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.axisy.3",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.aggregate_function.3",
                                       "value": 3
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.aggregate_interval.3",
                                       "value": "1m"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.aggregate_grouping.3",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "graph_time",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "time_from",
                                       "value": "now-3h"
                                   },
                                   {
                                       "type": 0,
                                       "name": "legend_lines",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show_problems",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

See also