28 上位アイテム

説明

これらのパラメータと、各ダッシュボードウィジェットの field オブジェクトに対する可能なプロパティ値により、dashboard.create および dashboard.update メソッドで Top items ウィジェットを設定できます。

ウィジェットの fields プロパティは、ダッシュボードの作成または更新時には検証されません。 これにより、ユーザーは 組み込みウィジェット を変更したり、カスタムウィジェット を作成したりできますが、同時にウィジェットを誤って作成または更新してしまうリスクも生じます。 Top items ウィジェットを確実に作成または更新するには、以下の表に示すパラメータの動作を参照してください。

パラメーター

以下のパラメーターは Top items ウィジェットでサポートされています。

Parameter type name value
Refresh interval 0 rf_rate 0 - 更新しない;
10 - 10秒;
30 - 30秒;
60 - (default) 1分;
120 - 2分;
600 - 10分;
900 - 15分。
Host groups 2 groupids.0 ホストグループ ID。

Note: 複数のホストグループを設定するには、プロパティ名の番号を増やしながら、各ホストグループごとに dashboard widget field オブジェクトを作成します。

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Host groups (Widget) 1 groupids._reference ホストグループ ID の代わりに:
ABCDE._hostgroupids - 互換ウィジェット をデータソースとしてホストグループに設定します(Reference パラメーターを "ABCDE" に設定)。

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Hosts 3 hostids.0 ホスト ID。

Note: 複数のホストを設定するには、プロパティ名の番号を増やしながら、各ホストごとに dashboard widget field オブジェクトを作成します。複数のホストを設定する場合、パラメーター Host groups は未設定にするか、設定するホストが属するホストグループを少なくとも1つ含めて設定する必要があります。

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Hosts (Widget/Dashboard) 1 hostids._reference ホスト ID の代わりに:
DASHBOARD.hostids - Host セレクター をホストのデータソースとして設定します;
ABCDE._hostids - 互換ウィジェット をデータソースとしてホストに設定します(Reference パラメーターを "ABCDE" に設定)。

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Host tags
Evaluation type 0 host_tags_evaltype 0 - (default) And/Or;
2 - Or.

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Tag name 1 host_tags.0.tag 任意の文字列値。

Note: プロパティ名の数字は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- required if configuring Host tags

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Operator 0 host_tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

Note: プロパティ名の数字は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- required if configuring Host tags

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Tag value 1 host_tags.0.value 任意の文字列値。

Note: プロパティ名の数字は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- required if configuring Host tags

このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。
Layout 0 layout 0 - (default) 横;
1 - 縦。
Show problems 0 show_problems 0 - すべて;
1 - (default) 未抑制;
2 - なし。
Items (see below)

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番目の数字がある場合は設定されたエンティティ(例: アイテムパターン、タグ)を表します。

Parameter type name value
アイテムパターン 1 columns.0.items.0 アイテムの名前またはパターン(例: "*: 1秒あたりの処理済み*値数")。

注: 複数のアイテムパターンを設定するには、各アイテムパターンごとに、プロパティ名の2番目の数字を増やした dashboard widget field オブジェクトを作成します。

テンプレートダッシュボードでウィジェットを設定する場合は、テンプレートで設定されているアイテムのパターンのみを設定してください。

パラメータの動作:
- 必須
アイテムタグ
評価タイプ 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。

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
塗りつぶし 0 columns.0.sparkline.fill 指定可能な値の範囲は 0-10 です。

デフォルト: 3。

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
1 columns.0.sparkline.color 16進カラーコード(例: FF0000)。

デフォルト: 42A5F5

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
期間 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - 期間 セレクターをデータソースとして設定します;
ABCDE._timeperiod - 互換性のあるウィジェットreference パラメータが ABCDE と等しいもの)をデータソースとして設定します。

デフォルト: DASHBOARD._timeperiod

または、期間は FromTo パラメータのみで設定することもできます。

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
From 1 columns.0.sparkline.time_period.from 絶対時間(YYYY-MM-DD hh:mm:ss)または 相対 時刻構文(now, now/d, now/w-1w など)で指定された有効な時刻文字列。

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
- columns.0.sparkline.time_period.to が設定されている場合は 必須
To 1 columns.0.sparkline.time_period.to 絶対時間(YYYY-MM-DD hh:mm:ss)または 相対 時刻構文(now, now/d, now/w-1w など)で指定された有効な時刻文字列。

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
- columns.0.sparkline.time_period.from が設定されている場合は 必須
履歴データ 0 columns.0.sparkline.history 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。

パラメータの動作:
- 表示 が "スパークライン" に設定されている場合に サポート
しきい値
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

または、期間は FromTo パラメータのみで設定することもできます。

パラメータの動作:
- 集計関数 が "min", "max", "avg", "count", "sum", "first", "last" に設定されている場合に サポート
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" に設定されている場合に サポート
- columns.0.time_period.to が設定されている場合は 必須
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" に設定されている場合に サポート
- columns.0.time_period.from が設定されている場合は 必須
履歴データ 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:

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

参照