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
データセットの設定には、以下のパラメータがサポートされています。
プロパティ名の最初の数字（例：ds.0.hosts.0、ds.0.items.0）は特定のデータセットを表し、2番目の数字（存在する場合）は設定されたホストまたはアイテムを表します。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| データセットタイプ | 0 | ds.0.dataset_type | 0 - アイテムリスト; 1 - (デフォルト) アイテムパターン |
|
| Items | 4 | ds.0.itemids.0 | Item ID テンプレートダッシュボード でウィジェットを設定する場合は、テンプレートで設定されている項目のみを設定する必要があります。 注: 複数の項目を設定するには、プロパティ名に増分番号が付いた各項目のダッシュボードウィジェットフィールドオブジェクトを作成します。 パラメータの動作: - データセットタイプ が"アイテムリスト"に設定され、アイテム (ウィジェット) が設定されていない場合は 必須 です |
|
| アイテム（ウィジェット） | 1 | ds.0.itemids.0._reference | アイテム ID:ABCDE._itemid の代わりに、アイテムのデータソースとして 互換性のあるウィジェット（Reference パラメータを "ABCDE に設定）を設定します。注: 複数のウィジェットを設定するには、各ウィジェットに対して、プロパティ名に増分番号を付けたダッシュボードウィジェットフィールドオブジェクトを作成します。 このパラメータは、Zabbix 7.0.1 以降でサポートされています。 パラメータの動作: - データセットタイプ が "アイテムリスト" に設定され、アイテム が設定されていない場合は 必須 です |
|
| 色 | 1 | ds.0.color.0 | 16進数のカラーコード（例：FF0000）パラメータの動作: - データセットタイプが"アイテムリスト"に設定されている場合、必須です。 |
|
| ホストパターン | 1 | ds.0.hosts.0 | ホストの名前またはパターン（例："Zabbix*"） パラメータの動作: - データセットタイプが"アイテムパターン"に設定されている場合、必須です。 このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合、サポートされません。 |
|
| アイテムパターン | 1 | ds.0.items.0 | アイテム の名前またはパターン (例: "*: 1 秒あたりに処理される * 値の数") テンプレート ダッシュボード でウィジェットを構成する場合は、テンプレートで構成されているアイテムのパターンのみを設定する必要があります。 パラメータの動作: - データセット タイプ が "アイテム パターン" に設定されている場合、必須 |
|
| 色 | 1 | ds.0.color | 16進数のカラーコード（例：FF0000）デフォルト： FF465Cパラメータの動作: - データセットタイプが"アイテムパターン"に設定されている場合にサポートされます。 |
|
| 描画 | 0 | ds.0.type | 0 - (デフォルト) 線 1 - ポイント 2 - 階段 3 - バー |
|
| Stacked | 0 | ds.0.stacked | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - Draw が"Line"、"Staircase"、または"Bar"に設定されている場合に サポートされます |
|
| Width | 0 | ds.0.width | 有効な値の範囲は 1～10 です。 デフォルト: 1 パラメータの動作: - Draw が"Line"または"Staircase"に設定されている場合に サポートされます |
|
| ポイントサイズ | 0 | ds.0.pointsize | 有効な値の範囲は 1 ～ 10 です。 デフォルト: 3. パラメータの動作: - Draw が "Points" に設定されている場合に サポートされます |
|
| 透明度 | 0 | ds.0.transparency | 有効な値の範囲は 1 ～ 10 です。 デフォルト: 5. |
|
| 塗りつぶし | 0 | ds.0.fill | 有効な値の範囲は 1 ～ 10 です。 デフォルト: 3. パラメータの動作: - Draw が "Line" または "Staircase" に設定されている場合に サポートされます |
|
| 欠損データ | 0 | ds.0.missingdatafunc | 0 - (デフォルト) なし; 1 - 接続済み; 2 - 0 として扱う; 3 - 最終既知 パラメータの動作: - Draw が"直線"または"階段"に設定されている場合、サポートされます |
|
| Y 軸 | 0 | ds.0.axisy | 0 - (デフォルト) 左; 1 - 右 |
|
| 時間シフト | 1 | ds.0.timeshift | 有効な時間文字列 (例: 3600、1h など)時間接尾辞 を使用できます。負の値も使用できます。 デフォルト: "" (空) |
|
| 集計関数 | 0 | ds.0.aggregate_function | 0 - (デフォルト) 未使用 1 - 最小値 2 - 最大値 3 - 平均 4 - 個数 5 - 合計 6 - 先頭 7 - 最終 |
|
| 集計間隔 | 1 | ds.0.aggregate_interval | 有効な時間文字列 (例: 3600、1h など)時間サフィックス を使用できます。 デフォルト: 1h |
|
| 集計 | 0 | ds.0.aggregate_grouping | 0 - (デフォルト) 各項目 1 - データセット パラメータの動作: - 集計関数が"min"、"max"、"avg"、"count"、"sum"、"first"、または"last"に設定されている場合、サポートされます。 |
|
| 近似値 | 0 | ds.0.approximation | 1 - 最小値 2 - (デフォルト) 平均 4 - 最大値 7 - すべて |
|
| データセットラベル | 1 | ds.0.data_set_label | 任意の文字列値 デフォルト: "" (空) |
|
Display options
表示オプションの設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 履歴データの選択 | 0 | source | 0 - (デフォルト) 自動; 1 - 履歴; 2 - トレンド |
|
| シンプルトリガー | 0 | simple_triggers | 0 - (デフォルト) 無効; 1 - 有効 |
|
| 稼働時間 | 0 | working_time | 0 - (デフォルト) 無効; 1 - 有効 |
|
| パーセンタイル線（左） | ||||
| ステータス | 0 | percentile_left | 0 - (デフォルト) 無効; 1 - 有効 パラメーターの動作: - Y軸 (データセット 構成内) が"左"に設定されている場合に サポートされます。 |
|
| 値 | 0 | percentile_left_value | 指定可能な値の範囲は 1～100 です。 パラメーターの動作: - Y軸 (データセット 構成内) が"左"に設定されている場合に サポートされます。 |
|
| パーセンタイル線 (右) | ||||
| ステータス | 0 | percentile_right | 0 - (デフォルト) 無効; 1 - 有効 パラメーターの動作: - Y 軸 (データセット 構成内) が"右"に設定されている場合に サポートされます。 |
|
| 値 | 0 | percentile_right_value | 可能な値の範囲は 1～100 です。 パラメーターの動作: - Y 軸 (データセット 構成内) が"右"に設定されている場合に サポートされます。 |
|
Time period
期間 の設定には、以下のパラメータがサポートされています。
| パラメータ | type | 名前 | 値 | |
|---|---|---|---|---|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット（Referenceパラメータを"ABCDE"に設定）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、FromパラメータとToパラメータでのみ期間を設定することもできます。 |
|
| From | 1 | time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポートされます。 |
|
| To | 1 | time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポートされます。 |
|
軸
軸の設定には、以下のパラメーターがサポートされています。
| パラメーター | type | name | value |
|---|---|---|---|
| 左Y軸 | 0 | lefty | 0 - 無効 1 - (デフォルト) 有効 パラメーターの動作: - Y軸 (データセット 設定内) が"左"に設定されている場合に サポート されます。 |
| 右 Y | 0 | righty | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - Y 軸 (データセット 設定内) が"右"に設定されている場合に サポート されます。 |
| 最小値 | 1 | lefty_min | 任意の数値 デフォルト: "" (空) |
| righty_min | |||
| 最大値 | 1 | lefty_max | 任意の数値 デフォルト: "" (空) |
| righty_max | |||
| 単位 (タイプ) | 0 | lefty_units | 0 - (デフォルト) 自動; 1 - 静的 |
| righty_units | |||
| 単位 (値) | 1 | lefty_static_units | 任意の文字列値 デフォルト: "" (空) |
| righty_static_units | |||
| X軸 | 0 | xaxis | 0 - 無効; 1 - (デフォルト) 有効 |
凡例
凡例の設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value |
|---|---|---|---|
| 凡例の表示 | 0 | 凡例 | 0 - 無効 1 - (デフォルト) 有効 パラメータの動作: - 凡例の表示が"有効"に設定されている場合にサポートされます。 |
| 最小値/平均値/最大値を表示 | 0 | legend_statistic | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - 凡例の表示が"有効"に設定されている場合にサポートされます |
| 集計関数の表示 | 0 | legend_aggregation | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - 凡例の表示が"有効"に設定されている場合にサポートされます |
| 行数 | 0 | legend_lines_mode | 0 - (デフォルト) 固定 1 - 可変 パラメータの動作: - 凡例の表示 が"有効"に設定されている場合に サポートされます |
| 行数/ 最大行数 |
0 | legend_lines | 指定可能な値の範囲は 1～10 です。 デフォルト: 1 パラメータの動作: - 凡例の表示 が"有効"に設定されている場合に サポートされます。 |
| 列数 | 0 | legend_columns | 可能な値の範囲は1〜4です。 デフォルト: 4. パラメータの動作: - 凡例の表示が"有効"に設定され、最小値/平均値/最大値の表示が"無効"に設定されている場合にサポートされます。 |
Problems
問題の設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 問題を表示 | 0 | show_problems | 0 - (デフォルト) 無効; 1 - (デフォルト) 有効 |
|
| 選択された項目のみ | 0 | graph_item_problems | 0 - (デフォルト) 有効 | |
| 問題のあるホスト | 1 | problemhosts.0 | ホスト 名 注: プロパティ名の数字は、設定されたホストを参照します。 複数のホストを設定するには、プロパティ名に増分番号を付けたダッシュボード ウィジェット フィールド オブジェクトをホストごとに作成します。 このパラメーターは、テンプレート ダッシュボード でウィジェットを設定する場合、サポートされません。 |
|
| 重大度 | 0 | severities.0 | 0 - 分類なし 1 - 情報 2 - 警告 3 - 平均 4 - 高 5 - 災害 デフォルト: 空 (すべて有効) 注: 複数の値を設定するには、プロパティ名に増分番号を付けたダッシュボード ウィジェット フィールド オブジェクトを値ごとに作成します。 |
|
| 問題 | 1 | problem_name | 問題イベント名 (大文字と小文字は区別されません。完全な名前またはその一部) | |
| 問題タグ | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) And/Or; 2 - Or. |
|
| タグ名 | 1 | tags.0.tag | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 問題タグ を構成する場合は 必須 |
|
| 演算子 | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - 問題のあるタグを構成する場合は必須 |
|
| タグ値 | 1 | tags.0.value | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - 問題のあるタグを構成する場合は必須 |
|
Overrides
オーバーライドの設定には、以下のパラメーターがサポートされています。
プロパティ名の最初の数字（例: or.0.hosts.0、or.0.items.0）は特定のデータセットを表し、2番目の数字は（存在する場合）設定されたホストまたはアイテムを表します。
| パラメーター | type | 名前 | 値 |
|---|---|---|---|
| ホストパターン | 1 | または.0.hosts.0 | ホスト の名前またはパターン (例: Zabbix*)このパラメーターは、テンプレートダッシュボード でウィジェットを設定する場合、サポートされません。 パラメーターの動作: - オーバーライド を設定する場合は 必須 |
| アイテムパターン | 1 | または.0.items.0 | アイテム の名前またはパターン (例: *: 1 秒あたりに処理される *値の数)テンプレートダッシュボード でウィジェットを設定する場合は、テンプレートで設定されているアイテムのパターンのみを設定する必要があります。 パラメーターの動作: - オーバーライド を設定する場合は 必須 |
| 基本色 | 1 | または.0.color | 16 進数カラーコード (例: FF0000) |
| 幅 | 0 | または.0.width | 指定可能な値の範囲は 1～10 です。 |
| 描画 | 0 | or.0.type | 0 - 線; 1 - ポイント; 2 - 階段; 3 - 棒グラフ |
| 透明度 | 0 | or.0.transparency | 有効な値の範囲は 1 ～ 10 です。 |
| 塗りつぶし | 0 | or.0.fill | 有効な値の範囲は 1 ～ 10 です。 |
| ポイント サイズ | 0 | or.0.pointsize | 有効な値の範囲は 1 ～ 10 です。 |
| 欠損データ | 0 | or.0.missingdatafunc | 0 - なし; 1 - 接続済み; 2 - 0 として処理; 3 - 最終値 |
| Y 軸 | 0 | or.0.axisy | 0 - 左; 1 - 右 |
| 時間シフト | 1 | または.0.timeshift | 有効な時間文字列（例：3600、1h など）時間接尾辞を使用できます。負の値も使用できます。 |
例
次の例は、グラフウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、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
}レスポンス: