Documentation
Table of Contents
20 Pie chart
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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.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）パラメータの動作: - データセットタイプが"アイテムリスト"に設定されている場合にサポートされます*。 |
|
| 項目タイプ | 0 | ds.0.type.0 | 0 - (デフォルト) 通常 1 - 合計 "合計"の値は、チャート全体の1つの項目にのみ設定できます。 パラメータの動作: - データセットタイプが"アイテムリスト"に設定されている場合にサポートされます。 |
|
| ホストパターン | 1 | ds.0.hosts.0 | ホスト の名前またはパターン (例: "Zabbix*") パラメータの動作: - データセットタイプ が "アイテムパターン" に設定されている場合、必須です。 テンプレートダッシュボード でウィジェットを構成する場合、このパラメータはサポートされません。 |
|
| アイテムパターン | 1 | ds.0.items.0 | アイテム の名前またはパターン (例: "*: 1 秒あたりに処理される * 値の数") テンプレート ダッシュボード でウィジェットを構成する場合は、テンプレートで構成されているアイテムのパターンのみを設定する必要があります。 パラメータの動作: - データセット タイプ が "アイテム パターン" に設定されている場合は 必須 |
|
| 色 | 1 | ds.0.color | 16 進数カラーコード (例: FF0000)パラメータの動作: - データセット タイプ が "アイテム パターン" に設定されている場合は サポート |
|
| 集計関数 | 0 | ds.0.aggregate_function | 1 - 最小値; 2 - 最大値; 3 - 平均; 4 - 個数; 5 - 合計; 6 - 先頭; 7 - (デフォルト) 最後 |
|
| データセット集計 | 0 | ds.0.dataset_aggregation | 0 - (デフォルト) なし; 1 - 最小値; 2 - 最大値; 3 - 平均; 4 - 個数; 5 - 合計 パラメータの動作: - アイテムタイプ が"合計"に設定されている場合に サポート されます |
|
| データ セット ラベル | 1 | ds.0.data_set_label | 任意の文字列値 デフォルト: "" (空) |
|
表示オプション
表示オプションの設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 履歴データの選択 | 0 | source | 0 - (default) 自動; 1 - 履歴; 2 - トレンド |
|
| 描画 | 0 | draw_type | 0 - (default) 円グラフ; 1 - ドーナツグラフ |
|
| 幅 | 0 | width | 20 - 半径の20%; 30 - 半径の30%; 40 - 半径の40%; 50 - (デフォルト) 半径の50% パラメータの動作: - Draw が "Doughnut" に設定されている場合に サポートされます |
|
| ストローク幅 | 0 | stroke | 設定可能な値の範囲は0～10です。 デフォルト: 0 このパラメータは、Zabbix 7.0.1以降でサポートされています。 パラメータの動作: - Draw が "Doughnut" に設定されている場合に サポートされます |
|
| 合計値を表示 | 0 | total_show | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - Draw が"ドーナツ"に設定されている場合に サポートされます |
|
| Size | 0 | value_size_type | 0 - (デフォルト) 自動; 1 - カスタム パラメータの動作: - 合計値を表示 が"有効"に設定されている場合に サポートされます。 |
|
| サイズ (カスタムサイズの値) | 0 | value_size | 有効な値の範囲は 1～100 です。 デフォルト: 20 パラメータの動作: - 合計値の表示 が"有効"に設定されている場合に サポートされます。 |
|
| 小数点以下の桁数 | 0 | decimal_places | 有効な値の範囲は 0～6 です。 デフォルト: 2 パラメータの動作: - 合計値の表示 が"有効"に設定されている場合に サポートされます。 |
|
| 単位 (チェックボックス) | 0 | units_show | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - 合計値の表示 が"有効"に設定されている場合に サポートされます。 |
|
| 単位 (値) | 1 | units | 任意の文字列値 パラメータの動作: - 単位 (チェックボックス) が"有効"に設定されている場合に サポートされます。 |
|
| 太字 | 0 | value_bold | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - 合計値の表示 が"有効"に設定されている場合に サポートされます。 |
|
| 色 | 1 | value_color | 16進数のカラーコード (例: FF0000)パラメータの動作: - 合計値の表示 が"有効"に設定されている場合に サポートされます。 |
|
| セクター間のスペース | 0 | space | 指定可能な値の範囲は0～10です。 デフォルト: 1 |
|
| N% 未満のセクターをマージ (チェックボックス) | 0 | merge | 0 - (デフォルト) 無効; 1 - 有効 |
|
| N% 未満のセクターをマージ (値) | 0 | merge_percent | 指定可能な値の範囲は 1～10 です。 デフォルト: 1 パラメータの動作: - N% 未満のセクターをマージ (チェックボックス) が"有効"に設定されている場合に サポート されます。 |
|
| N% 未満のセクターをマージ (色) | 1 | merge_color | 16 進数のカラー コード (例: FF0000)パラメーターの動作: - N% 未満のセクターをマージ (チェックボックス) が "有効" に設定されている場合に サポート されます。 |
|
期間
期間 の設定には、以下のパラメータがサポートされています。
| パラメータ | 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 |
|---|---|---|---|
| 凡例の表示 | 0 | legend | 0 - 無効; 1 - (デフォルト) 有効 |
| 値の表示 | 0 | legend_value | 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. パラメータの動作: - 凡例の表示が「有効」に設定され、値の表示が「無効」に設定されている場合に サポートされます。 |
例
次の例は、円グラフウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
円グラフウィジェットの設定
円グラフウィジェットは、以下の手順で設定します:
- 1つのホストに、合計9つのアイテムのデータセットを2つ作成します。
- 最初のデータセットはタイプが"アイテムリスト"で、3つのアイテムで構成されています。これらのアイテムはすべて"通常"タイプで、それぞれ異なる色で表示されます。
- 2つめのデータセットはタイプが"アイテムパターン"で、6つのアイテムで構成されています。これらのアイテムは集計が設定され、カスタム色で表示されます。
- 2つめのデータセットには、カスタムデータセットラベルも設定します。
- 円グラフのデータは、幅がカスタムで、中央に単位が付いた合計値を持つドーナツグラフとして表示されます。
- 円グラフのデータは、過去3時間のカスタム期間について表示および集計されます。
- 円グラフの凡例には、設定されたアイテムが4行で表示されます。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"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": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.3",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.3",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.3",
"value": 0
},
{
"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.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: