Documentation
8 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分 |
データセット
データセットの設定には、以下のパラメータがサポートされています。
プロパティ名の最初の数字（例：ds.hosts.0.0、ds.items.0.0）は特定のデータセットを表し、2番目の数字（存在する場合）は設定されたホストまたはアイテムを表します。
| パラメータ | type | name | value |
|---|---|---|---|
| ホストパターン (必須) |
1 | ds.hosts.0.0 | ホスト の名前またはパターン（例：Zabbix*） |
| アイテムパターン (必須) |
1 | ds.items.0.0 | アイテム の名前またはパターン (例: *: 1 秒あたりの処理済み値の数) |
| 色 | 1 | ds.color.0 | 16 進数カラーコード (例: FF0000)デフォルト: FF465C |
| 描画 | 0 | ds.type.0 | 0 - (デフォルト) 線 1 - ポイント 2 - 階段 3 - バー |
| 幅 | 0 | ds.width.0 | 有効な値の範囲は 1～10 です。 デフォルト: 1 描画 が"ポイント"または"バー"に設定されている場合、パラメーター 幅 は使用できません。 |
| ポイント サイズ | 0 | ds.pointsize.0 | 有効な値の範囲は 1～10 です。 デフォルト: 3 パラメータ ポイント サイズ は、描画 が"線"、"階段"、または"バー"に設定されている場合は使用できません。 |
| 透明度 | 0 | ds.transparency.0 | 有効な値の範囲は 1～10 です。 デフォルト: 5 |
| 塗りつぶし | 0 | ds.fill.0 | 有効な値の範囲は 1～10 です。 デフォルト: 3 パラメータ 塗りつぶし は、描画 が"ポイント"または"バー"に設定されている場合は使用できません。 |
| 欠損データ | 0 | ds.missingdatafunc.0 | 0 - (デフォルト) なし; 1 - 連結; 2 - 0として扱います。 パラメータ 欠損データ は、Draw が"ポイント"または"バー"に設定されている場合は使用できません。 |
| Y軸 | 0 | ds.axisy.0 | 0 - (デフォルト) 左; 1 - 右 |
| 時間シフト | 1 | ds.timeshift.0 | 有効な時間文字列（例：3600、1h など）時間サフィックス を使用できます。負の値も使用できます。 デフォルト: "" (空) |
| 集計関数 | 0 | ds.aggregate_function.0 | 0 - (デフォルト) なし; 1 - 最小; 2 - 最大; 3 - 平均; 4 - カウント; 5 - 合計; 6 - 最初; 7 - 最後 |
| 集計間隔 | 1 | ds.aggregate_interval.0 | 有効な時間文字列 (例: 3600、1h など)時間サフィックス を使用できます。 デフォルト: 1h |
| Aggregate | 0 | ds.aggregate_grouping.0 | 0 - (デフォルト) 各項目 1 - データ セット Aggregation function が "none" に設定されている場合、パラメーター Aggregate は使用できません。 |
表示オプション
表示オプションの設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value |
|---|---|---|---|
| 履歴データの選択 | 0 | ソース | 0 - (デフォルト) 自動; 1 - 履歴; 2 - トレンド |
期間
期間の設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value |
|---|---|---|---|
| カスタム期間の設定 | 0 | graph_time | 0 - (デフォルト) 無効; 1 - 有効 |
| 開始 | 1 | time_from | 有効な時刻文字列（YYYY-MM-DD hh:mm:ss 形式）相対期間 値（ now、now/d、now/w-1w など）もサポートされています。デフォルト: now-1h |
| To | 1 | time_to | YYYY-MM-DD hh:mm:ss 形式の有効な時刻文字列値相対期間 値 ( now、now/d、now/w-1w など) もサポートされています。デフォルト: now |
軸
軸の設定には、以下のパラメータがサポートされています。
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| 左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 | 名前 | 値 |
|---|---|---|---|
| 凡例の表示 | 0 | legend | 0 - 無効; 1 - (デフォルト) 有効 |
| 行数 | 0 | legend_lines | 有効な値の範囲は1～5です。 デフォルト: 1 |
問題
問題の設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 問題を表示 | 0 | show_problems | 0 - (デフォルト) 無効; 1 - (デフォルト) 有効 |
|
| 選択された項目のみ | 0 | graph_item_problems | 0 - (デフォルト) 有効 | |
| 問題のあるホスト | 1 | problemhosts.0 | ホスト の名前 注: プロパティ名に含まれる数字は、設定されているホストを参照します。 複数のホストを設定するには、ホ ストごとにダッシュボード ウィジェット フィールド オブジェクトを作成します。 |
|
| 重大度 | 0 | 重大度 | 0 - 分類なし; 1 - 情報; 2 - 警告; 3 - 平均; 4 - 高; 5 - 災害 デフォルト: 空 (すべて有効) 注: 複数の値を設定するには、値ごとにダッシュボード ウィジェット フィールド オブジェクトを作成します。 |
|
| 問題 | 1 | problem_name | 問題 イベント名 (大文字と小文字を区別しない、完全な名前またはその一部) | |
| タグ (プロパティ名内の数字 (例: tags.tag.0) は、タグ評価リスト内のタグの順序を表します) | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) And/Or; 2 - Or |
|
| タグ名 | 1 | tags.tag.0 | 任意の文字列値 タグ を設定する場合は、パラメータ タグ名 が必要です。 |
|
| 演算子 | 0 | tags.operator.0 | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない タグ を設定する場合は、パラメータ 演算子 が必要です。 |
|
| タグ値 | 1 | tags.value.0 | 任意の文字列値 タグを構成する場合は、パラメータ タグ値 が必要です。 |
|
オーバーライド
オーバーライドの設定には、以下のパラメーターがサポートされています。
プロパティ名の最初の数字（例：or.hosts.0.0、or.items.0.0）は特定のデータセットを表し、2番目の数字が存在する場合は設定されたホストまたはアイテムを表します。
| パラメーター | type | name | value |
|---|---|---|---|
| ホストパターン (必須) |
1 | or.hosts.0.0 | ホスト の名前またはパターン（例：Zabbix*） |
| アイテムパターン (必須) |
1 | or.items.0.0 | アイテム の名前またはパターン (例: *: 1 秒あたりに処理される *値の数) |
| 基本色 | 1 | or.color.0 | 16 進数のカラーコード (例: FF0000) |
| 幅 | 0 | or.width.0 | 有効な値の範囲は 1～10 です。 |
| 描画 | 0 | or.type.0 | 0 - 線、 1 - 点、 2 - 階段、 3 - 棒 |
| 透明度 | 0 | or.transparency.0 | 有効な値の範囲は 1～10 です。 |
| 塗りつぶし | 0 | or.fill.0 | 有効な値の範囲は 1～10 です。 |
| ポイントサイズ | 0 | または.pointsize.0 | 有効な値の範囲は1～10です。 |
| 欠損データ | 0 | または.missingdatafunc.0 | 0 - なし; 1 - 接続済み; 2 - 0として扱う。 |
| Y軸 | 0 | または.axisy.0 | 0 - 左; 1 - 右 |
| 時間シフト | 1 | または.timeshift.0 | 有効な時間文字列（例：3600、1hなど）時間サフィックスを使用できます。負の値も使用できます。 |
例
次の例は、グラフウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
グラフウィジェットの設定
グラフウィジェットを次のように設定します。
- 1つのホストに合計9つのアイテムの4つのデータセットがあります。
- 各データセットは、カスタムの色、幅、透明度、塗りつぶしを持つ線で構成されています。
- データセット4には集計が設定されています。
- グラフのデータは、過去3時間のデータが表示されます。
- グラフ内の障害は、設定されたアイテムについてのみ表示されます。
- グラフには2つのY軸があり、右側のY軸にはデータセット4の値のみが表示されます。
- グラフの凡例には、設定されたアイテムが2行で表示されます。
リクエスト:
{
"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
}レスポンス: