Documentation
Table of Contents
11 Honeycomb
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでハニカムウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 ハニカムウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
Honeycomb ウィジェットでは、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
| ホスト グループ | 2 | groupids.0 | ホスト グループ ID 注: 複数のホスト グループを構成するには、プロパティ名に増分番号を含む各ホスト グループのダッシュボード ウィジェット フィールド オブジェクトを作成します。 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| ホスト グループ (ウィジェット) | 1 | groupids._reference | ホスト グループ ID:ABCDE._hostgroupids の代わりに、ホスト グループのデータ ソースとして 互換性のあるウィジェット (Reference パラメータを "ABCDE に設定) を設定します。このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合、サポートされません。 |
|
| ホスト | 3 | hostids.0 | ホスト ID 注: 複数のホストを構成するには、プロパティ名に増分番号を含むダッシュボード ウィジェット フィールド オブジェクトをホストごとに作成します。複数のホストの場合、パラメータ ホスト グループ はまったく構成されていないか、構成されたホストが属する少なくとも 1 つのホスト グループで構成されている必要があります。 このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| ホスト タグ | ||||
| 評価タイプ | 0 | evaltype_host | 0 - (デフォルト) And/Or; 2 - Or. このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合、サポートされません。 |
|
| タグ名 | 1 | host_tags.0.tag | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - ホスト タグ を構成する場合は 必須 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合、サポートされません。 |
|
| 演算子 | 0 | host_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - ホストタグ を構成する場合は 必須 このパラメーターは、テンプレートダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| タグ値 | 1 | host_tags.0.value | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグ順序を参照します。 パラメーターの動作: - ホストタグ を構成する場合は 必須 このパラメーターは、テンプレートダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| アイテムパターン | 1 | items.0 | アイテム の名前またはパターン 注: 複数のアイテムパターンを構成するには、プロパティ名に増分番号を含む、アイテムパターンごとにダッシュボードウィジェットフィールドオブジェクトを作成します。 パラメーターの動作: - 必須 |
|
| アイテムタグ | ||||
| 評価タイプ | 0 | evaltype_item | 0 - (デフォルト) And/Or; 2 - Or |
|
| タグ名 | 1 | item_tags.0.tag | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメータの動作: - アイテムタグ を構成する場合は 必須 |
|
| 演算子 | 0 | item_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメータの動作: - アイテムタグ を構成する場合は 必須 |
|
| タグ値 | 1 | item_tags.0.value | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメータの動作: - アイテムタグ を構成する場合は 必須 |
|
| メンテナンス中のホストを表示 | 0 | メンテナンス | 0 - (デフォルト) 無効; 1 - 有効 |
|
| 表示 | 0 | 表示 0 | 1 - プライマリラベル; 2 - セカンダリラベル 注: 複数の値を設定するには、プロパティ名に増分番号を付けた各値のダッシュボードウィジェットフィールドオブジェクトを作成します。 デフォルト: 1、2 |
|
| 参照 | 1 | 参照 | 5 文字からなる任意の文字列値 (例: ABCDE または JBPNL)この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
|
Advanced configuration
Honeycomb ウィジェットでは、以下の詳細設定パラメータがサポートされています。
Thresholds プロパティ名（例：thresholds.0.color）の数字は、リスト内のしきい値の位置を示し、昇順でソートされます。 ただし、しきい値が異なる順序で設定されている場合は、Zabbix フロントエンドでウィジェット設定を更新すると、値は昇順でソートされます。 (例："thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5")
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| プライマリラベル | |||
| タイプ | 0 | primary_label_type | 0 - (デフォルト) テキスト; 1 - 値 |
| テキスト | 1 | primary_label | マクロを含む任意の文字列値 サポートされているマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ デフォルト: {HOST.NAME> パラメータの動作: - タイプ が "テキスト" に設定されている場合に サポート されます。 |
| 小数点以下の桁数 | 0 | primary_label_decimal_places | 有効な値の範囲は0-6です。 デフォルト: 2 パラメータの動作: - Type が"Value"に設定されている場合にサポートされます。 |
| Size (type) | 0 | primary_label_size_type | 0 - (デフォルト) 自動; 1 - カスタム |
| Size | 0 | primary_label_size | 有効な値の範囲は1-100です。 デフォルト: 20 パラメータの動作: - Size (type) が"Custom"に設定されている場合にサポートされます。 |
| 太字 | 0 | primary_label_bold | 0 - (デフォルト) 無効; 1 - 有効 |
| 色 | 1 | primary_label_color | 16進数カラーコード(例: FF0000)デフォルト: 設定オブジェクトとユーザーオブジェクトの theme に基づきます。1F2C33 (blue-theme) または "hc-light"EEEEEE (dark-theme) または "hc-dark" |
| 単位 (チェックボックス) | 0 | primary_label_units_show | 0 - 無効; 1 - (デフォルト) 有効 パラメータの動作: - タイプ が"値"に設定されている場合に サポート されます。 |
| 単位 (値) | 1 | primary_label_units | 任意の文字列値"" (空)パラメータの動作: - タイプ が"値"に設定され、単位 (チェックボックス) が"有効"に設定されている場合に サポート されます。 |
| 位置 | 0 | primary_label_units_pos | 0 - 前の値 1 - (デフォルト) 後の値 パラメータの動作: - タイプが"値"に設定され、単位 (チェックボックス)が"有効"に設定されている場合にサポートされます。 このパラメータは、次の時間関連の単位のいずれかに設定されている場合、無視されます。: unixtime、uptime、s |
| セカンダリラベル | |||
| タイプ | 0 | secondary_label_type | 0 - テキスト 1 - (デフォルト) 値 |
| テキスト | 1 | secondary_label | マクロを含む任意の文字列値 サポートされているマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ。 デフォルト: {{ITEM.LASTVALUE}.fmtnum(2)> パラメータの動作: - Type が "Text" に設定されている場合に サポートされます。 |
| 小数点以下の桁数 | 0 | secondary_label_decimal_places | 可能な値の範囲は 0-6 です。 デフォルト: 2 パラメータの動作: - Type が "Value" に設定されている場合に サポートされます。 |
| サイズ (type) | 0 | secondary_label_size_type | 0 - (デフォルト) 自動; 1 - カスタム |
| サイズ | 0 | secondary_label_size | 有効な値の範囲は1-100です。 デフォルト: 30 パラメータの動作: - サイズ (type) が"カスタム"に設定されている場合に サポートされます。 |
| 太字 | 0 | secondary_label_bold | 0 - 無効; 1 - (デフォルト) 有効 |
| 色 | 1 | secondary_label_color | 16進数カラーコード（例：FF0000）デフォルト：設定オブジェクトおよびユーザーオブジェクトの themeに基づきます。"blue-theme"または"hc-light"の場合は 1F2C33、"dark-theme"または"hc-dark"の場合は EEEEEE |
| 単位（チェックボックス） | 0 | secondary_label_units_show | 0 - 無効 1 - （デフォルト） 有効 パラメータの動作: - Type が"Value"に設定されている場合にサポートされます。 |
| 単位 (値) | 1 | secondary_label_units | 任意の文字列値"" (空)パラメータの動作: - タイプ が"値"に設定され、単位 (チェックボックス) が"有効"に設定されている場合に サポート されます。 |
| 位置 | 0 | secondary_label_position | 0 - 前の値 1 - (デフォルト) 後の値 パラメータの動作: - タイプ が"値"に設定され、単位 (チェックボックス) が"有効"に設定されている場合に サポート されます。 このパラメータは、次の 時間関連の単位 のいずれかに設定されている場合、無視されます。: unixtime、uptime、s |
| 背景色 | |||
| 背景色 | 1 | bg_color | 16進数カラーコード（例：FF0000）デフォルト：設定オブジェクトおよびユーザーオブジェクトの themeに基づきます。"blue-theme"の場合は D9E7ED、"dark-theme"の場合は 3D5059、"hc-light"の場合は AAD7E9、"hc-dark"の場合は 335463 |
| しきい値 | |||
| 色補間 | 0 | 補間 | 0 - 無効、 1 - (デフォルト) 有効 |
| Color | 1 | thresholds.0.color | 16進数のカラーコード（例：FF0000） |
| Threshold | 1 | thresholds.0.threshold | 任意の数値サフィックス（例："1d"、"2w"、"4K"、"8G"）がサポートされています。 |
例
次の例は、ハニカムウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
ハニカムウィジェットの設定
Zabbixサーバープロセスの使用率を表示するハニカムウィジェットを設定します。 さらに、ハニカムセルのプライマリラベルを変更し、しきい値を設定してウィジェットを視覚的に微調整します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "honeycomb",
"name": "Honeycomb",
"x": "0",
"y": "0",
"width": "24",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "items.0",
"value": "Zabbix server: Utilization*"
},
{
"type": 1,
"name": "primary_label",
"value": "{ITEM.NAME}"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "70"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "90"
},
{
"type": 1,
"name": "reference",
"value": "KSTMQ"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: