Documentation
Table of Contents
9 Graph
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでグラフウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 グラフウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
グラフウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | type | name | value |
|---|---|---|---|
| リフレッシュ間隔 | 0 | rf_rate | 0 - 更新なし 10 - 10秒 30 - 30秒 60 - (デフォルト) 1分 120 - 2分 600 - 10分 900 - 15分 |
| 参照 | 1 | reference | 5文字で構成される文字列値(例: ABCDEまたはJBPNL)。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。パラメーターの動作: - 必須 |
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 | |
|---|---|---|---|---|
| Data set type | 0 | ds.dataset_type.0 | 0 - Item list; 1 - (default) Item pattern. |
|
| Parameters if Data set type is set to "Item list" | ||||
| Items (required) |
4 | ds.itemids.0.0 | Item ID. Note: To configure multiple items, create a dashboard widget field object for each item. |
|
| Color (required) |
1 | ds.color.0.0 | Hexadecimal color code (e.g. FF0000). |
|
| Parameters if Data set type is set to "Item pattern" | ||||
| 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. |
|
| Stacked | 0 | ds.stacked.0 | 0 - (default) Disabled; 1 - Enabled. Parameter Stacked not available if Draw is set to "Points". |
|
| 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; 3 - Last known. 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". |
|
| Approximation | 0 | ds.approximation.0 | 1 - min; 2 - (default) avg; 4 - max; 7 - all. |
|
| Data set label | 1 | ds.data_set_label.0 | Any string value. Default: "" (empty). |
|
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. |
|
| Simple triggers | 0 | simple_triggers | 0 - (default) Disabled; 1 - Enabled. |
|
| Working time | 0 | working_time | 0 - (default) Disabled; 1 - Enabled. |
|
| Percentile line (left) (parameter available if Y-axis (in Data set configuration) is set to "Left") | ||||
| Status | 0 | percentile_left | 0 - (default) Disabled; 1 - Enabled. |
|
| Value | 0 | percentile_left_value | Valid values range from 1-100. | |
| Percentile line (right) (parameter available if Y-axis (in Data set configuration) is set to "Right") | ||||
| Status | 0 | percentile_right | 0 - (default) Disabled; 1 - Enabled. |
|
| Value | 0 | percentile_right_value | Valid values range from 1-100. | |
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. |
| Display min/max/avg | 0 | legend_statistic | 0 - (default) Disabled; 1 - Enabled. |
| Number of rows | 0 | legend_lines | Valid values range from 1-10. Default: 1. |
| Number of columns | 0 | legend_columns | Valid values range from 1-4. Default: 4. |
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; 3 - Last known. |
| 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. |
例
次の例は、グラフウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
グラフウィジェットの設定
グラフウィジェットを次のように設定します。
- 1つのホストに合計9つのアイテムの2つのデータセットがあります。
- 最初のデータセットはタイプが"アイテムリスト"で、3つのアイテムで構成され、異なる色で幅、透明度および塗りつぶしは同じ線で表されます。
- 2番目のデータセットはタイプが"アイテムパターン"で、6つのアイテムで構成され、集計を設定されており、カスタムの色、幅、透明度および塗りつぶしの線で表されます。
- 2番目のデータセットには、カスタムデータセットラベルもあります。
- グラフのデータは、過去3時間のデータが表示されます。
- グラフ内の障害は、設定されたアイテムについてのみ表示されます。
- グラフには2つのY軸があり、右側のY軸には2番目のデータセットの値のみが表示されます。
- グラフの凡例には、設定されたアイテムが4行で表示され、データセットの最小値、最大値、平均値を表します。
{
"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": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "FF0000"
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "BF00FF"
},
{
"type": 4,
"name": "ds.0.itemids.3",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.3",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.width",
"value": 3
},
{
"type": 0,
"name": "ds.0.transparency",
"value": 3
},
{
"type": 0,
"name": "ds.0.fill",
"value": 1
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.transparency",
"value": 0
},
{
"type": 0,
"name": "ds.1.fill",
"value": 0
},
{
"type": 0,
"name": "ds.1.axisy",
"value": 1
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.aggregate_interval",
"value": "1m"
},
{
"type": 0,
"name": "ds.1.aggregate_grouping",
"value": 1
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_statistic",
"value": 1
},
{
"type": 0,
"name": "legend_lines",
"value": 4
},
{
"type": 0,
"name": "show_problems",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "YZABC"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: