6 Gauge
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでゲージウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
ゲージウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
ゲージウィジェットでサポートされているパラメーターは以下の通りです。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| アイテム | 4 | itemid.0 | アイテムのID。 パラメーターの動作: - アイテム(ウィジェット)が設定されていない場合は必須 |
|
| アイテム(ウィジェット) | 1 | itemid._reference | アイテムのIDの代わりに:ABCDE._itemid - 互換性のあるウィジェット（参照パラメーターを"ABCDE"に設定）をアイテムのデータソースとして設定します。パラメーターの動作: - アイテムが設定されていない場合は必須 |
|
| 最小値 | 1 | min | 任意の数値。サフィックス（例："1d"、"2w"、"4K"、"8G"）がサポートされています。 デフォルト: "0"。 |
|
| 最大値 | 1 | max | 任意の数値。サフィックス（例："1d"、"2w"、"4K"、"8G"）がサポートされています。 デフォルト: "100"。 |
|
| 値アーク | 1 | value_arc_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
|
| アーク背景 | 1 | empty_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
|
| 背景 | 1 | bg_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
|
| 表示 | 0 | show.0 | 1 - 説明; 2 - 値; 3 - 針; 4 - 目盛り; 5 - 値アーク。 注: 複数の値を設定するには、プロパティ名の番号を増やして各値ごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 デフォルト: 1, 2, 4, 5。 以下の両方の場合、「針」と「目盛り」の値はサポートされません: - 値「値アーク」の表示用のダッシュボードウィジェットフィールドオブジェクトが設定されていない; - アーク表示 詳細設定パラメーターが「無効」に設定されている。 表示オプションの詳細設定パラメーターは、該当する値のダッシュボードウィジェットフィールドオブジェクトが設定されていない場合はサポートされません。 |
|
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット（参照パラメーターを"ABCDE"に設定）をホストのデータソースとして設定;DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定。このパラメーターはテンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
詳細設定
Gauge ウィジェットでは、以下の詳細設定パラメータがサポートされています。
Thresholds プロパティ名の数値（例: thresholds.0.color）は、昇順に並べ替えられたリスト内でのしきい値の位置を参照します。
ただし、しきい値が別の順序で設定されている場合、Zabbix Webインターフェースでウィジェット設定を更新した後に値は昇順に並べ替えられます
（例: "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| Parameter | type | name | value |
|---|---|---|---|
| Angle | 0 | angle | Possible values: 180 (default) or 270. |
| Description | |||
| Description | 1 | description | Any string value, including macros. Supported macros: {HOST.*}, {ITEM.*}, {INVENTORY.*}, user macros.Default: {ITEM.NAME}. |
| Size | 0 | desc_size | Possible values range from 1-100. Default: 15. |
| Vertical position | 0 | desc_v_pos | 0 - Top; 1 - (default) Bottom. |
| Bold | 0 | desc_bold | 0 - (default) Disabled; 1 - Enabled. |
| Color | 1 | desc_color | Hexadecimal color code (e.g., FF0000).Default: "" (empty). |
| Value | |||
| Decimal places | 0 | decimal_places | Possible values range from 1-10. Default: 2. |
| Size | 0 | value_size | Possible values range from 1-100. Default: 25. |
| Bold | 0 | value_bold | 0 - (default) Disabled; 1 - Enabled. |
| Color | 1 | value_color | Hexadecimal color code (e.g., FF0000).Default: "" (empty). |
| Units | |||
| Units (checkbox) | 0 | units_show | 0 - Disabled; 1 - (default) Enabled. |
| Units (value) | 1 | units | Any string value. Parameter behavior: - supported if Units (checkbox) is set to "Enabled" |
| Size | 0 | units_size | Possible values range from 1-100. Default: 25. Parameter behavior: - supported if Units (checkbox) is set to "Enabled" |
| Bold | 0 | units_bold | 0 - (default) Disabled; 1 - Enabled. Parameter behavior: - supported if Units (checkbox) is set to "Enabled" |
| Position | 0 | units_pos | 0 - 値の前; 1 - 値の上; 2 - (default) 値の後; 3 - 値の下. Parameter behavior: - supported if Units (checkbox) is set to "Enabled" This parameter is ignored if set to one of the following time-related units: unixtime, uptime, s. |
| Color | 1 | units_color | Hexadecimal color code (e.g., FF0000).Default: "" (empty). |
| Value arc | |||
| Arc size | 0 | value_arc_size | Possible values range from 1-100. Default: 20. |
| Needle | |||
| Color | 1 | needle_color | Hexadecimal color code (e.g., FF0000).Default: "" (empty).Parameter behavior: - supported if a dashboard widget field object for Show with the value "Value arc" is set, or Show arc is set to "Enabled" |
| Scale | |||
| Show units | 0 | scale_show_units | 0 - Disabled; 1 - (default) Enabled. Parameter behavior: - supported if Units (checkbox) is set to "Enabled" and either a dashboard widget field object for Show with the value "Value arc" is set, or Show arc is set to "Enabled" |
| Size | 0 | scale_size | Possible values range from 1-100. Default: 15. Parameter behavior: - supported if a dashboard widget field object for Show with the value "Value arc" is set, or Show arc is set to "Enabled" |
| Decimal places | 0 | scale_decimal_places | Possible values range from 1-10. Default: 0. Parameter behavior: - supported if a dashboard widget field object for Show with the value "Value arc" is set, or Show arc is set to "Enabled" |
| Thresholds | |||
| Color | 1 | thresholds.0.color | Hexadecimal color code (e.g., FF0000). |
| Threshold | 1 | thresholds.0.threshold | Any numeric value. Suffixes (e.g., "1d", "2w", "4K", "8G") are supported. |
| Show labels | 0 | th_show_labels | 0 - (default) Disabled; 1 - Enabled. Parameter behavior: - supported if Thresholds are set and either a dashboard widget field object for Show with the value "Value arc" is set or Show arc is set to "Enabled" |
| Show arc | 0 | th_show_arc | 0 - (default) Disabled; 1 - Enabled. Parameter behavior: - supported if Thresholds are set |
| Arc size | 0 | th_arc_size | Possible values range from 1-100. Default: 5. Parameter behavior: - supported if Show arc is set to "Enabled" |
例
次の例は、ゲージウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
ゲージウィジェットの設定
アイテム"44474" (インターフェース enp0s3: 送信ビット数)の値を表示するゲージウィジェットを設定します。 さらに、しきい値などの複数の詳細オプションを使用して、ウィジェットを視覚的に微調整します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "gauge",
"name": "Gauge",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 44474
},
{
"type": 1,
"name": "min",
"value": "100000"
},
{
"type": 1,
"name": "max",
"value": "1000000"
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 0,
"name": "show.4",
"value": 4
},
{
"type": 0,
"name": "show.5",
"value": 5
},
{
"type": 0,
"name": "angle",
"value": 270
},
{
"type": 0,
"name": "desc_size",
"value": 10
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 0,
"name": "decimal_places",
"value": 0
},
{
"type": 0,
"name": "value_bold",
"value": 1
},
{
"type": 0,
"name": "units_size",
"value": 15
},
{
"type": 0,
"name": "units_pos",
"value": 3
},
{
"type": 1,
"name": "needle_color",
"value": "3C3C3C"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "700000"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "500000"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "100000"
},
{
"type": 0,
"name": "th_show_labels",
"value": 1
},
{
"type": 0,
"name": "th_show_arc",
"value": 1
},
{
"type": 0,
"name": "th_arc_size",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}