Documentation
Table of Contents
6 Gauge
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでゲージウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 ゲージウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
Gauge ウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
| Item | 4 | itemid.0 | Item ID パラメーターの動作: - Item (Widget) が設定されていない場合は 必須 です。 |
|
| Item (Widget) | 1 | itemid._reference | Item ID:ABCDE._itemid の代わりに、アイテムのデータソースとして 互換性のあるウィジェット (Reference パラメーターが "ABCDE に設定されている) を設定します。パラメーターの動作: - Item が設定されていない場合は 必須 です。 |
|
| 最小値 | 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 | 表示.0 | 1 - 説明; 2 - 値; 3 - 針; 4 - スケール; 5 - 値の円弧. 注: 複数の値を構成するには、プロパティ名に増分番号を付けて、各値のダッシュボード ウィジェット フィールド オブジェクトを作成します。 デフォルト: 1、2、4、5 値「針」と「スケール」は、次の両方の場合にはサポートされません。 - 値が「値の円弧」の 表示 のダッシュボード ウィジェット フィールド オブジェクトが設定されていない。 - 表示円弧 詳細設定 パラメータが「無効」に設定されている。 対応する値が設定されたダッシュボード ウィジェット フィールド オブジェクトが設定されていない場合、表示 オプションの 詳細設定 パラメータはサポートされません。 |
|
| 上書きするホスト | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット (その Reference パラメータを "ABCDE に設定) をホストのデータ ソースとして設定します。DASHBOARD._hostid - ダッシュボードの ホスト セレクタ をホストのデータ ソースとして設定します。このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合にはサポートされません。 |
|
Advanced configuration
Gauge ウィジェットでは、以下の詳細設定パラメータがサポートされています。
Thresholds プロパティ名（例：thresholds.0.color）の数字は、リスト内のしきい値の位置を示し、昇順でソートされます。 ただし、しきい値が異なる順序で設定されている場合は、Zabbix フロントエンドでウィジェット設定を更新すると、値は昇順でソートされます。 (例："thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5")
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| 角度 | 0 | 角度 | 指定可能な値: 180 (デフォルト) または 270 |
| 説明 | |||
| 説明 | 1 | 説明 | マクロを含む任意の文字列値 サポートされているマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ デフォルト: {ITEM.NAME} |
| サイズ | 0 | desc_size | 指定可能な値の範囲は 1-100 です。 デフォルト: 15 |
| 垂直位置 | 0 | desc_v_pos | 0 - 上; 1 - (デフォルト) 下 |
| 太字 | 0 | desc_bold | 0 - (デフォルト) 無効; 1 - 有効 |
| 色 | 1 | desc_color | 16進数のカラーコード (例: FF0000)デフォルト: "" (空) |
| 値 | |||
| 小数点 | 0 | decimal_places | 指定可能な値の範囲は1-10です。 デフォルト: 2 |
| サイズ | 0 | value_size | 指定可能な値の範囲は1-100です。 デフォルト: 25 |
| 太字 | 0 | value_bold | 0 - (デフォルト) 無効; 1 - 有効 |
| Color | 1 | value_color | 16進数のカラーコード（例：FF0000）デフォルト： ""（空） |
| 単位 | |||
| 単位（チェックボックス） | 0 | units_show | 0 - 無効 1 - （デフォルト） 有効 |
| 単位（値） | 1 | units | 任意の文字列値 パラメータの動作: - 単位（チェックボックス）が"有効"に設定されている場合にサポートされます |
| サイズ | 0 | units_size | 有効な値の範囲は1-100です。 デフォルト: 25 パラメータの動作: - 単位 (チェックボックス) が"有効"に設定されている場合にサポートされます |
| 太字 | 0 | units_bold | 0 - (デフォルト) 無効 1 - 有効 パラメータの動作: - 単位 (チェックボックス) が"有効"に設定されている場合にサポートされます |
| 位置 | 0 | units_pos | 0 - 値の前 1 - 値の上 2 - (デフォルト) 値の後 3 - 値の下 パラメータの動作: - 単位 (チェックボックス) が"有効"に設定されている場合に サポート されます。 このパラメータは、次の 時間関連の単位 のいずれかに設定されている場合、無視されます。: unixtime、uptime、s |
| 色 | 1 | units_color | 16進数のカラーコード (例: FF0000)デフォルト: "" (空) |
| 値の円弧 | |||
| 円弧サイズ | 0 | value_arc_size | 有効な値の範囲は1-100です。 デフォルト: 20 |
| ニードル | |||
| 色 | 1 | needle_color | 16進数のカラーコード（例: FF0000）デフォルト: ""（空）パラメータの動作: - ダッシュボードウィジェットのフィールドオブジェクトで、表示に"値円弧"が設定されている場合、または表示円弧が"有効"に設定されている場合にサポートされます。 |
| スケール | |||
| 単位の表示 | 0 | scale_show_units | 0 - 無効; 1 - (デフォルト) 有効 パラメータの動作: - 単位 (チェックボックス) が"有効"に設定され、ダッシュボード ウィジェットの 表示 のフィールド オブジェクトで値が"値の円弧"に設定されているか、表示円弧 が"有効"に設定されている場合に サポートされます。 |
| サイズ | 0 | scale_size | 指定可能な値の範囲は 1-100 です。 デフォルト: 15 パラメータの動作: - 表示 のダッシュボード ウィジェットのフィールド オブジェクトで値が"値の円弧"に設定されているか、表示円弧 が"有効"に設定されている場合に サポートされます。 |
| 小数点以下の桁数 | 0 | scale_decimal_places | 有効な値の範囲は1-10です。 デフォルト: 0 パラメータの動作: - ダッシュボードウィジェットのフィールドオブジェクトで、表示に"Value arc"が設定されている場合、または表示 arcが"有効"に設定されている場合にサポートされます。 |
| しきい値 | |||
| 色 | 1 | thresholds.0.color | 16進数のカラーコード(例: FF0000) |
| しきい値 | 1 | thresholds.0.threshold | 任意の数値サフィックス (例: "1d"、"2w"、"4K"、"8G") がサポートされています。 |
| ラベルを表示 | 0 | th_show_labels | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - しきい値 が設定されており、ダッシュボード ウィジェットの 表示 フィールド オブジェクトに値 "Value arc" が設定されているか、表示アーク が "有効" に設定されている場合は サポート されます。 |
| 円弧`を表示 | 0 | th_show_arc | 0 - (デフォルト) 無効; 1 - 有効 パラメータの動作: - しきい値 が設定されている場合は サポート されます。 |
| 円弧のサイズ | 0 | th_arc_size | 可能な値の範囲は 1-100 です。 デフォルト: 5 パラメータの動作: - 円弧の表示 が "有効" に設定されている場合は サポート されます。 |
例
次の例は、ゲージウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、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
}レスポンス: