29 トップアイテム

説明

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

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

パラメータ

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

パラメータ 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つ設定されている必要があります。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト (ウィジェット/ダッシュボード) 1 hostids._reference ホスト IDの代わりに:
DASHBOARD.hostids - ダッシュボードのホストセレクタをホストのデータソースとして設定します;
ABCDE._hostids - Referenceパラメータを"ABCDE"に設定した互換性のあるウィジェットをホストのデータソースとして設定します。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホストタグ
評価タイプ 0 host_tags_evaltype 0 - (デフォルト) And/Or;
2 - Or。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
タグ名 1 host_tags.0.tag 任意の文字列値。

注: プロパティ名の番号はタグ評価リスト内のタグ順を参照します。

パラメータの動作:
- 必須 (Host tagsを設定する場合)

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
演算子 0 host_tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

注: プロパティ名の番号はタグ評価リスト内のタグ順を参照します。

パラメータの動作:
- 必須 (Host tagsを設定する場合)

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
タグ値 1 host_tags.0.value 任意の文字列値。

注: プロパティ名の番号はタグ評価リスト内のタグ順を参照します。

パラメータの動作:
- 必須 (Host tagsを設定する場合)

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
レイアウト 0 layout 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 アイテム名またはパターン(例:": Number of processed values per second")。

注:複数のアイテムパターンを設定するには、各アイテムパターンごとにプロパティ名の2つ目の数字を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。

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

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

または、FromおよびToパラメータで期間のみを設定することもできます。

パラメータの動作:
- 表示が「スパークライン」の場合にサポート
From 1 columns.0.sparkline.time_period.from 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/w-1wなど)の有効な時間文字列。

パラメータの動作:
- 表示が「スパークライン」の場合にサポート
- columns.0.sparkline.time_period.toが設定されている場合は必須
To 1 columns.0.sparkline.time_period.to 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/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 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last。

値の表示形式が「テキスト」の場合:
0 - (デフォルト) 使用しない;
4 - count;
6 - first;
7 - last。
期間 1 columns.0.time_period._reference DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定;
ABCDE._timeperiod - 互換性のあるウィジェットreferenceパラメータがABCDEのもの)をデータソースとして設定。

デフォルト:DASHBOARD._timeperiod

または、FromおよびToパラメータで期間のみを設定することもできます。

パラメータの動作:
- 集計関数が「min」、「max」、「avg」、「count」、「sum」、「first」、「last」の場合にサポート
From 1 columns.0.time_period.from 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/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)または相対時間構文(nownow/dnow/w-1wなど)の有効な時間文字列。

パラメータの動作:
- 期間が設定されておらず、集計関数が「min」、「max」、「avg」、「count」、「sum」、「first」、「last」の場合にサポート
- columns.0.time_period.fromが設定されている場合は必須
履歴データ 0 columns.0.history 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。

パラメータの動作:
- 値の表示形式が「数値」の場合にサポート
集計 0 columns.0.aggregate_columns 0 - (デフォルト) 各アイテム
1 - 結合。

パラメータの動作:
- 値の表示形式が「数値」で表示が「そのまま」、「バー」または「インジケーター」の場合にサポート
結合集計関数 0 columns.0.column_aggregate_function 1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum (デフォルト)

パラメータの動作:
- 集計を設定する場合は必須
結合カラム名 1 columns.0.combined_column_name 任意の文字列値。

パラメータの動作:
- 集計を設定する場合は必須

次の例は、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
}

参照