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番目の数字が存在する場合は、設定されたホストまたはアイテムを表します。

Parameter type name value
データセットタイプ 0 ds.0.dataset_type 0 - アイテムリスト;
1 - (デフォルト) アイテムパターン。
アイテム 4 ds.0.itemids.0 Item ID。
ウィジェットをテンプレートダッシュボード上で設定する場合は、テンプレート上で設定されたアイテムのみを指定する必要があります。

注意: 複数のアイテムを設定するには、プロパティ名の番号を増やして、各アイテムごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。

Parameter behavior:
- 必須データセットタイプ が「アイテムリスト」に設定され、アイテム (ウィジェット) が設定されていない場合
アイテム (ウィジェット) 1 ds.0.itemids.0._reference Item ID の代わりに:
ABCDE._itemid - 互換性のあるウィジェット(その Reference パラメータが "ABCDE" に設定されているもの)を、アイテムのデータソースとして設定します。

注意: 複数のウィジェットを設定するには、プロパティ名の番号を増やして、各ウィジェットごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。

このパラメータは Zabbix 7.0.1 以降でサポートされています。

Parameter behavior:
- 必須データセットタイプ が「アイテムリスト」に設定され、アイテム が設定されていない場合
1 ds.0.color.0 16進数のカラーコード(例: FF0000)。

Parameter behavior:
- 必須データセットタイプ が「アイテムリスト」に設定されている場合
アイテムタイプ 0 ds.0.type.0 0 - (デフォルト) 通常;
1 - 合計。

値「合計」は、チャート全体で1つのアイテムに対してのみ設定できます。

Parameter behavior:
- サポートデータセットタイプ が「アイテムリスト」に設定されている場合
ホストパターン 1 ds.0.hosts.0 Host 名またはパターン(例: "Zabbix*")。

Parameter behavior:
- 必須データセットタイプ が「アイテムパターン」に設定されている場合

このパラメータは、ウィジェットをテンプレートダッシュボード上で設定する場合はサポートされません。
アイテムパターン 1 ds.0.items.0 Item 名またはパターン(例: "*: 1秒あたりに処理された *values の数")。

ウィジェットをテンプレートダッシュボード上で設定する場合は、テンプレート上で設定されたアイテムのパターンのみを指定する必要があります。

Parameter behavior:
- 必須データセットタイプ が「アイテムパターン」に設定されている場合
1 ds.0.color 16進数のカラーコード(例: FF0000)。

Parameter behavior:
- サポートデータセットタイプ が「アイテムパターン」に設定されている場合
集計関数 0 ds.0.aggregate_function 1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - (デフォルト) last。
データセット集計 0 ds.0.dataset_aggregation 0 - (デフォルト) なし;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum。

Parameter behavior:
- サポートアイテムタイプ が「合計」に設定されている場合
データセットラベル 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 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)または相対時間構文(nownow/dnow/w-1w など)の有効な時間文字列。

パラメータの動作:
- 期間 が設定されていない場合に supported
- time_period.to が設定されている場合に required
To 1 time_period.to 絶対時間形式(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/w-1w など)の有効な時間文字列。

パラメータの動作:
- 期間 が設定されていない場合に supported
- time_period.from が設定されている場合に required

凡例

凡例の設定では、以下のパラメータがサポートされています。

パラメータ 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つのデータセットを設定します。
  • 1つ目のデータセットは「アイテムリスト」タイプで、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.0",
                                "value": 23264
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.0",
                                "value": "FF0000"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.type.0",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.1",
                              "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.2",
                              "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": 1,
                                "name": "time_period.to",
                                "value": "now"
                            },
                            {
                                "type": 0,
                                "name": "legend_lines",
                                "value": 4
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参照