Documentation
Table of Contents
27 Top items
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで上位アイテムウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 上位アイテムウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
トップアイテムウィジェットでは、以下のパラメータがサポートされています。
| パラメータ | 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 | host_tags_evaltype | 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 | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグ順序を参照します。 パラメーターの動作: - ホストタグ を構成する場合は 必須 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| レイアウト | 0 | レイアウト | 0 - (デフォルト) 水平 1 - 垂直 |
|
| 問題の表示 | 0 | show_problems | 0 - すべて 1 - (デフォルト) 抑制なし 2 - なし |
|
| 項目 (以下を参照) | ||||
Advanced configuration
上位アイテムウィジェットでは、以下の詳細設定パラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| ホストの順序 | ||||
| 並べ替え | 0 | host_ordering_order_by | 0 - (default) ホスト名; 3 - アイテムの値 |
|
| アイテムパターン | 1 | host_ordering_item.0 | アイテム の名前またはパターン（例："*: 1 秒あたりに処理される * 値の数"） 注: 複数のアイテムパターンを設定するには、プロパティ名に増分番号を含む各アイテムパターンのダッシュボードウィジェットフィールドオブジェクトを作成します。 テンプレートダッシュボード でウィジェットを設定する場合は、テンプレートで構成されているアイテムのパターンのみを設定する必要があります。 パラメータの動作: - Order by が "Item value" に設定されている場合、必須 |
|
| Order | 0 | host_ordering_order | 2 - (デフォルト) 上位 N 件; 3 - 下位 N 件 |
|
| 制限 | 0 | host_ordering_limit | 有効な値の範囲は1～100です。 デフォルト: 10 |
|
| アイテムの順序 | ||||
| 順序付け | 0 | item_ordering_order_by | 1 - ホスト 2 - アイテム名 3 - (デフォルト) アイテムの値 |
|
| ホストパターン | 1 | item_ordering_host.0 | ホスト の名前またはパターン 注: 複数のホストパターンを設定するには、プロパティ名に増分番号を付けた、ホストパターンごとにダッシュボードウィジェットフィールドオブジェクトを作成します。 パラメータの動作: - 順序付け が "Host" に設定されている場合は 必須 |
|
| 順序 | 0 | item_ordering_order | 2 - (デフォルト) 上位 N 件; 3 - 下位 N 件 |
|
| 制限 | 0 | item_ordering_limit | 指定可能な値の範囲は 1 ～ 100 です。 デフォルト: 10 件 |
|
列
プロパティ名の最初の数字 (例: columns.0.items.0、columns.0.item_tags_evaltype) は特定の列を表し、2 番目の数字 (存在する場合) は構成されたエンティティ (例: アイテム パターン、タグ) を表します。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| アイテム パターン | 1 | columns.0.items.0 | アイテム の名前またはパターン (例: "*: 1 秒あたりに処理される * 値の数") 注: 複数のアイテム パターンを構成するには、プロパティ名に秒数を増分した各アイテム パターンのダッシュボード ウィジェット フィールド オブジェクトを作成します。 テンプレート ダッシュボード でウィジェットを構成する場合は、テンプレートで構成されているアイテムのパターンのみを設定する必要があります。 パラメーターの動作: - 必須 |
|
| アイテムタグ | ||||
| 評価タイプ | 0 | columns.0.item_tags_evaltype | 0 - (デフォルト) And/Or; 2 - Or |
|
| タグ名 | 1 | columns.0.item_tags.0.tag | 任意の文字列値 注: プロパティ名の 2 番目の数字は、タグ評価リスト内のタグ順序を参照します。 パラメーターの動作: - アイテム タグ を構成する場合は 必須 |
|
| 演算子 | 0 | columns.0.item_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない 注: プロパティ名の 2 番目の数字は、タグ評価リストのタグ順序を参照します。 パラメーターの動作: - アイテム タグ を構成する場合は 必須 |
|
| タグ値 | 1 | columns.0.item_tags.0.value | 任意の文字列値 注: プロパティ名の 2 番目の数字は、タグ評価リスト内のタグ順序を参照します。 パラメーターの動作: - アイテム タグ を構成する場合は 必須 |
|
| 基本色 | 1 | columns.0.base_color | 16進数のカラーコード（例：FF0000） |
|
| 値の表示形式 | 0 | columns.0.display_value_as | 1 - (デフォルト) 数値; 2 - テキスト |
|
| 表示 | 0 | columns.0.display | 1 - (デフォルト) そのまま; 2 - 棒; 3 - インジケーター; 6 - スパークライン |
|
| 最小 | 1 | columns.0.min | 任意の数値サフィックス (例: "1d"、"2w"、"4K"、"8G") がサポートされています。 パラメーターの動作: - 表示値の種類 が "数値" に設定され、表示 が "バー" または "インジケーター" に設定されている場合に サポート されます。 |
|
| 最大 | 1 | columns.0.max | 任意の数値サフィックス (例: "1d"、"2w"、"4K"、"8G") がサポートされています。 パラメーターの動作: - 値の表示形式 が "数値" に設定され、表示 が "バー" または "インジケーター" に設定されている場合に サポート されます。 |
|
| スパークライン | ||||
| 幅 | 0 | columns.0.sparkline.width | 可能な値の範囲は 0 ～ 10 デフォルト: 1. パラメーターの動作: - Display が "Sparkline" に設定されている場合に サポート されます。 |
|
| Fill | 0 | columns.0.sparkline.fill | 可能な値の範囲は 0 ～ 10 デフォルト: 3. パラメーターの動作: - Display が "Sparkline" に設定されている場合に サポート されます。 |
|
| 色 | 1 | columns.0.sparkline.color | 16進数カラーコード（例：FF0000）デフォルト： 42A5F5パラメーターの動作: - Display が "Sparkline" に設定されている場合に サポート されます. |
|
| 期間 | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット（referenceパラメータがABCDEに等しい）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、FromパラメータとToパラメータでのみ期間を設定することもできます。 パラメータの動作: - Displayが"スパークライン" |
|
| From | 1 | columns.0.sparkline.time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメーターの動作: - Display が "Sparkline" に設定されている場合に サポート されます。 |
|
| To | 1 | columns.0.sparkline.time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメーターの動作: - Display が "Sparkline" に設定されている場合に サポート されます。 |
|
| 履歴データ | 0 | columns.0.sparkline.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - 傾向 パラメーターの動作: - Display が "Sparkline" に設定されている場合に サポート されます。 |
|
| しきい値 | ||||
| 色 | 1 | columns.0.thresholds.0.color | 16進数カラーコード（例：FF0000）パラメータの動作: - 値の表示形式が"数値"に設定されている場合にサポートされます。 |
|
| しきい値 | 1 | columns.0.thresholds.0.threshold | 任意の数値サフィックス (例: "1d"、"2w"、"4K"、"8G") がサポートされています。 パラメーターの動作: - 値の表示形式 が "数値" に設定されている場合は サポート されます。 |
|
| ハイライト | ||||
| ハイライト | 1 | columns.0.highlights.0.color | 16進数カラーコード（例：FF0000）パラメータの動作: - 値の表示形式が"テキスト"に設定されている場合にサポートされます。 |
|
| しきい値 | 1 | columns.0.highlights.0.pattern | 任意の正規表現 パラメータの動作: - 値の表示形式が"テキスト"に設定されている場合にサポートされます。 |
|
| 小数点以下の桁数 | 0 | columns.0.decimal_places | 有効な値の範囲は0～10 デフォルト: 2 |
|
| 詳細設定 | ||||
| 集計関数 | 0 | columns.0.aggregate_function | 値の表示形式が"数値"に設定されている場合: 0 - (デフォルト) 未使用; 1 - 最小; 2 - 最大; 3 - 平均; 4 - 件数; 5 - 合計; 6 - 先頭; 7 - 最後 値の表示形式が"テキスト"に設定されている場合: 0 - (デフォルト) 未使用; 4 - 件数; 6 - 先頭; 7 - 最後 |
|
| 期間 | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - データソースとして 期間 セレクター を設定します。ABCDE._timeperiod - データソースとして 互換性のあるウィジェット (reference パラメータが ABCDE に等しい) を設定します。デフォルト: DASHBOARD._timeperiodまたは、From パラメータと To パラメータでのみ期間を設定することもできます。 パラメータの動作: - 集計関数 が "min" に設定されている場合に サポートされます。 "最大"、"平均"、"カウント"、"合計"、"最初"、"最後" |
|
| From | 1 | columns.0.time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメーターの動作: - 期間 が設定されておらず、集計関数 が "min"、"max"、"avg"、"count"、"sum"、"first"、"last" に設定されている場合に サポート されます。 |
|
| To | 1 | columns.0.time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメーターの動作: - 期間 が設定されておらず、集計関数 が "min"、"max"、"avg"、"count"、"sum"、"first"、"last" に設定されている場合に サポート されます。 |
|
| 履歴データ | 0 | columns.0.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - 傾向 パラメーターの動作: - 値の表示形式 が "数値" に設定されている場合に サポート されます。 |
|
例
次の例は、Top itemsウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
トップアイテム ウィジェットの設定
ホスト"10084"のデータと、名前が"component"のタグに値が"cpu"を含むアイテムのみを表示する トップアイテム ウィジェットを設定します。 さらに、ホストを上位に表示し、セルを表すために色付きのゲージバーを使用します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: