7.2.3 トレンドデータ管理
- 〈この項の構成〉
(1) トレンドデータオブジェクト
- 機能
-
トレンドデータ管理DBが保持しているトレンドデータを表すjsonオブジェクトです。
製品プラグインからjp1trendDataService.getTrendDataメソッドを実行すると,トレンドデータ管理サービス(Promscale)を経由して,戻り値のデータオブジェクトとして,トレンドデータオブジェクトが返却されます。
jp1TrendDataService.getTrendDataメソッドの詳細については,「4.5.17 jp1TrendDataService.getTrendData」を参照してください。
- 形式
{ "status":"状態", "data":{ "resultType":"結果タイプ", "result":[ {"metric":{ "ラベル名":"ラベル値", ... }, "values":[ [時刻,"値"], ... ] } ] } }
- メンバー
-
メンバーを次の表に示します。
表7‒23 トレンドデータオブジェクトのメンバー 項番
メンバー
データ型
説明
1
status
string
取得結果を表す文字列です。
取得に成功している場合,"success"が設定されます。
2
resultType
string
取得したデータのタイプを表す文字列です。
固定で"matrix"が設定されます。
3
result
配列
トレンドデータを表す配列です。
4
metric
配列
トレンドデータに付与されているラベルを格納する配列です。
5
ラベル名
string
トレンドデータに付与されているラベルの名前です。
6
ラベル値
string
トレンドデータに付与されているラベルの値です。
7
values
配列
時刻ごとのパフォーマンスデータを表す配列です。
8
時刻
数値
パフォーマンスデータの時刻(UTC 1970年1月1日00:00:00からの経過秒数)です。
9
値
数値
パフォーマンスデータの値です。
- 出力例
{ "status":"success", "data":{ "resultType":"matrix", "result":[ {"metric":{ "__name__":"foo", "job":"hoge" }, "values":[ [1617436800,"100"], [1617436830,"100"], [1617436860,"100"], [1617436890,"100"] ] } ] } }
(2) ラベルセットリストオブジェクト
- 機能
-
トレンドデータ管理DBが保持しているトレンドデータのラベルセットの一覧を表すjsonオブジェクトです。
製品プラグインからjp1trendDataService.getLabelListメソッドを実行すると,トレンドデータ管理サービス(Promscale)を経由して,戻り値のデータオブジェクトとして,ラベルセットリストオブジェクトが返却されます。
jp1TrendDataService.getLabelListメソッドの詳細については,「4.5.18 jp1TrendDataService.getLabelList」を参照してください。
- 形式
{ "status":"状態", "data":[ { "ラベル名":"ラベル値", ... }, { "ラベル名":"ラベル値", ... }, ... ] }
上記の定義内で,下記の部分は1つのラベルセットを示します。
{ "ラベル名":"ラベル値", ... },
- メンバー
-
メンバーを次の表に示します。
表7‒24 トレンドデータオブジェクトのメンバー 項番
メンバー
データ型
説明
1
status
string
取得結果を表す文字列です。
取得に成功している場合,"success"が設定されます。
2
ラベル名
string
トレンドデータに付与されているラベルの名前です。
3
ラベル値
string
トレンドデータに付与されているラベルの値です。
- 出力例
{ "status" : "success", "data" : [ { "__name__" : "up", "job" : "prometheus", "instance" : "localhost:9090" }, { "__name__" : "up", "job" : "node", "instance" : "localhost:9091" } ] }