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)。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。パラメーターの動作: - 必須 |
データセット
データセット の設定では、以下のパラメータがサポートされています。
プロパティ名の最初の数字(例: ds.0.hosts.0、ds.0.items.0)は特定のデータセットを表し、2番目の数字が存在する場合は、設定されたホストまたはアイテムを表します。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| データセットタイプ | 0 | ds.0.dataset_type | 0 - アイテムリスト; 1 - (デフォルト) アイテムパターン。 |
|
| アイテム | 4 | ds.0.itemids.0 | Item ID。 テンプレートダッシュボード 上でウィジェットを設定する場合は、テンプレート上で設定されたアイテムのみを指定する必要があります。 注意: 複数のアイテムを設定するには、プロパティ名の番号を増やして、各アイテムごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 パラメータの動作: - 必須 データセットタイプ が「アイテムリスト」に設定され、かつ アイテム(ウィジェット) が設定されていない場合 |
|
| アイテム(ウィジェット) | 1 | ds.0.itemids.0._reference | Item ID の代わりに:ABCDE._itemid - 互換性のあるウィジェット(その Reference パラメータが "ABCDE" に設定されているもの)を、アイテムのデータソースとして設定します。注意: 複数のウィジェットを設定するには、プロパティ名の番号を増やして、各ウィジェットごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 このパラメータは Zabbix 7.0.1 以降でサポートされています。 パラメータの動作: - 必須 データセットタイプ が「アイテムリスト」に設定され、かつ アイテム が設定されていない場合 |
|
| 色 | 1 | ds.0.color.0 | 16進数のカラーコード(例: FF0000)。パラメータの動作: - 必須 データセットタイプ が「アイテムリスト」に設定されている場合 |
|
| ホストパターン | 1 | ds.0.hosts.0 | Host 名またはパターン(例: "Zabbix*")。 パラメータの動作: - 必須 データセットタイプ が「アイテムパターン」に設定されている場合 このパラメータは、テンプレートダッシュボード 上でウィジェットを設定する場合はサポートされません。 |
|
| アイテムパターン | 1 | ds.0.items.0 | Item 名またはパターン(例: "*: 1秒あたりに処理された *values の数")。 テンプレートダッシュボード 上でウィジェットを設定する場合は、テンプレート上で設定されたアイテムに対するパターンのみを指定する必要があります。 パラメータの動作: - 必須 データセットタイプ が「アイテムパターン」に設定されている場合 |
|
| 色 | 1 | ds.0.color | 16進数のカラーコード(例: FF0000)。デフォルト: FF465C。パラメータの動作: - サポート データセットタイプ が「アイテムパターン」に設定されている場合 |
|
| 描画 | 0 | ds.0.type | 0 - (デフォルト) 線; 1 - 点; 2 - 階段状; 3 - 棒。 |
|
| 積み重ね | 0 | ds.0.stacked | 0 - (デフォルト) 無効; 1 - 有効。 パラメータの動作: - サポート 描画 が「線」、「階段状」、または「棒」に設定されている場合 |
|
| 幅 | 0 | ds.0.width | 指定可能な値は 1~10 です。 デフォルト: 1。 パラメータの動作: - サポート 描画 が「線」または「階段状」に設定されている場合 |
|
| ポイントサイズ | 0 | ds.0.pointsize | 指定可能な値は 1~10 です。 デフォルト: 3。 パラメータの動作: - サポート 描画 が「点」に設定されている場合 |
|
| 透明度 | 0 | ds.0.transparency | 指定可能な値は 1~10 です。 デフォルト: 5。 |
|
| 塗りつぶし | 0 | ds.0.fill | 指定可能な値は 1~10 です。 デフォルト: 3。 パラメータの動作: - サポート 描画 が「線」または「階段状」に設定されている場合 |
|
| 欠損データ | 0 | ds.0.missingdatafunc | 0 - (デフォルト) なし; 1 - 接続; 2 - 0 として扱う; 3 - 最後の既知の値。 パラメータの動作: - サポート 描画 が「線」または「階段状」に設定されている場合 |
|
| Y軸 | 0 | ds.0.axisy | 0 - (デフォルト) 左; 1 - 右。 |
|
| 時間シフト | 1 | ds.0.timeshift | 有効な時間文字列(例: 3600、1h など)。時間サフィックス を使用できます。負の値も使用可能です。 デフォルト: ""(空)。 |
|
| 集計関数 | 0 | ds.0.aggregate_function | 0 - (デフォルト) 使用しない; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last。 |
|
| 集計間隔 | 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 - min; 2 - (デフォルト) avg; 4 - max; 7 - all。 |
|
| データセットラベル | 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 軸 (データセット 構成内) が"右"に設定されている場合に サポートされます。 |
|
期間
以下のパラメータは、期間 の設定でサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 期間 | 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 など)を指定します。パラメータの動作: - 期間 が設定されていない場合に supported - time_period.to が設定されている場合に required |
|
| To | 1 | time_period.to | 有効な時刻文字列。絶対時刻(YYYY-MM-DD hh:mm:ss)または相対時刻構文(now、now/d、now/w-1w など)を指定します。パラメータの動作: - 期間 が設定されていない場合に supported - time_period.from が設定されている場合に required |
|
軸
軸の設定には、以下のパラメーターがサポートされています。
| パラメーター | 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 | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - 問題のあるタグを構成する場合は必須 |
|
上書き
上書きの設定では、以下のパラメータを使用できます。
プロパティ名の最初の数字(例: or.0.hosts.0、or.0.items.0)は特定のデータセットを表し、2番目の数字が存在する場合は、設定されたホストまたはアイテムを表します。
| Parameter | type | name | value |
|---|---|---|---|
| ホストパターン | 1 | or.0.hosts.0 | ホスト名またはパターン(例: Zabbix*)。テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 パラメータの動作: - 上書きを設定する場合は必須 |
| アイテムパターン | 1 | or.0.items.0 | アイテム名またはパターン(例: *: Number of processed *values per second)。テンプレートダッシュボードでウィジェットを設定する場合は、テンプレート上で設定されたアイテムのパターンのみを指定する必要があります。 パラメータの動作: - 上書きを設定する場合は必須 |
| 基本色 | 1 | or.0.color | 16進数のカラーコード(例: FF0000)。 |
| 幅 | 0 | or.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 | or.0.timeshift | 有効な時間文字列(例: 3600、1h など)。時間サフィックスを使用できます。負の値も使用可能です。 |
例
次の例は、グラフウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
グラフウィジェットの設定
次のように グラフウィジェットを設定します。
- 1つのホスト上の合計9個のアイテムに対して、2つのデータセットを設定します。
- 1つ目のデータセットは「アイテムリスト」タイプで、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.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"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": 1,
"name": "time_period.to",
"value": "now"
},
{
"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
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}