Documentation
Table of Contents
15 Item history
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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分 |
| レイアウト | 0 | レイアウト | 0 - (デフォルト) 水平; 1 - 垂直 |
| 列 (下記を参照) | |||
| 行を表示 | 0 | show_lines | 有効な値の範囲は1～100です。 デフォルト: 25 |
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット（Referenceパラメータを"ABCDE"に設定）をホストのデータソースとして設定します。DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合、サポートされません。 |
| 詳細設定 (下記を参照) | |||
| 参照 | 1 | reference | 5文字からなる任意の文字列値 (例: ABCDE または JBPNL)。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
列
列には、アイテムパラメーターの設定に応じて、共通パラメーターと追加パラメーターがあります。
列に関連するすべてのパラメーターにおいて、プロパティ名に含まれる番号(例: columns.0.name)は、パラメーターが設定されている列を参照します。
以下のパラメータはすべての列でサポートされています。
| パラメータ | type | name | value |
|---|---|---|---|
| Name | 1 | columns.0.name | 任意の文字列値 パラメータの動作: - 必須 |
| 項目 | 4 | columns.0.itemid | 項目 ID テンプレートダッシュボードでウィジェットを設定する場合は、テンプレートで設定されている項目のみを設定する必要があります。 パラメーターの動作: - 必須 |
| 基本色 | 1 | columns.0.base_color | 16進数のカラーコード(例: FF0000)デフォルト: "" (空) |
設定されたItemが数値型の項目の場合、以下の列パラメータがサポートされます。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Display | 0 | columns.0.display | 1 - (default) そのまま; 2 - Bar; 3 - Indicators. |
|
| Min | 1 | columns.0.min | 任意の数値 Parameter behavior: - Display が"Bar"または"Indicators"に設定されている場合に サポート されます。 |
|
| 最大 | 1 | columns.0.max | 任意の数値 パラメータの動作: - 表示が"バー"または"インジケーター"に設定されている場合にサポートされます。 |
|
| しきい値 | ||||
| 色 | 1 | columns.0.thresholds.0.color | 16進数のカラーコード（例：FF0000） |
|
| しきい値 | 1 | columns.0.thresholds.0.threshold | 任意の数値サフィックス（例："1d"、"2w"、"4K"、"8G"）がサポートされています | |
| 履歴データ | 0 | columns.0.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - 傾向 |
|
設定された項目が文字、テキスト、またはログタイプの項目の場合、以下の列パラメータがサポートされます。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| ハイライト | ||||
| ハイライト | 1 | columns.0.highlights.0.color | 16進数のカラーコード（例：FF0000） |
|
| しきい値 | 1 | columns.0.highlights.0.pattern | 任意の正規表現 | |
| 表示 | 0 | columns.0.display | 1 - (デフォルト) そのまま; 4 - HTML; 5 - 単一行 |
|
| 単一行 | 0 | columns.0.max_length | 有効な値の範囲は1～500です。 デフォルト: 100 パラメータの動作: - Display が"単一行"に設定されている場合に サポートされます |
|
| 等幅フォントを使用する | 0 | columns.0.monospace_font | 0 - (デフォルト) デフォルトフォントを使用する。 1 - 等幅フォントを使用する。 |
|
| ローカル時刻を表示 | 0 | columns.0.local_time | 0 - (デフォルト) タイムスタンプを表示します。 1 - ローカル時刻を表示します。 パラメーターの動作: - Item がログ タイプ項目に設定され、Show timestamp が "Enabled" に設定されている場合に サポート されます。 |
|
設定されたアイテムがバイナリタイプのアイテムの場合、以下の列パラメータがサポートされます。
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| サムネイルを表示 | 1 | columns.0.show_thumbnail | 0 - (デフォルト) 無効; 1 - 有効 |
Advanced configuration
アイテム履歴ウィジェットでは、以下の詳細設定パラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 新しい値 | 0 | sortorder | 0 - (デフォルト) 上; 1 - 下 |
|
| タイムスタンプを表示 | 0 | show_timestamp | 0 - (デフォルト) 無効; 1 - 有効 |
|
| 列ヘッダーを表示 | 0 | show_column_header | 0 - オフ; 1 - 水平; 2 - (デフォルト) 垂直 |
|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット（Referenceパラメータを"ABCDE"に設定）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、FromパラメータとToパラメータでのみ期間を設定することもできます。 |
|
| From | 1 | time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポートされます。 |
|
| To | 1 | time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポートされます。 |
|
例
次の例は、アイテムヒストリウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
アイテムヒストリウィジェットの設定
2つの数値アイテム"42269"と"42270"の最新データを表示するアイテムヒストリウィジェットを設定します。 さらに、アイテム列を縦に、列名を横に表示するように設定します。表示データは15行に制限し、タイムスタンプ列を別に用意します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemhistory",
"name": "Item history",
"x": "0",
"y": "0",
"width": "18",
"height": "6",
"view_mode": "0",
"fields": [
{
"type": "0",
"name": "layout",
"value": "1"
},
{
"type": "1",
"name": "columns.0.name",
"value": "CPU utilization"
},
{
"type": "4",
"name": "columns.0.itemid",
"value": "42269"
},
{
"type": "1",
"name": "columns.1.name",
"value": "Memory utilization"
},
{
"type": "4",
"name": "columns.1.itemid",
"value": "42270"
},
{
"type": "0",
"name": "show_lines",
"value": "15"
},
{
"type": "0",
"name": "show_timestamp",
"value": "1"
},
{
"type": "0",
"name": "show_column_header",
"value": "1"
},
{
"type": "1",
"name": "reference",
"value": "KIVKD"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: