メトリック定義ファイル(metrics_プロダクトID.conf)
機能
メトリック定義ファイルは,JP1/IM2で使用するメトリックを追加・編集・削除するときに編集するファイルです。メトリック定義ファイルのモデルファイルは,JP1/IM2のインストール時に提供されます。
メトリック定義ファイルを,JP1/IM2のインストール直後の状態に戻したい場合は,モデルファイルで上書きしてください。
メトリック定義ファイルのファイル権限については,JP1/IM2のマニュアルを参照してください。
ファイル名
metrics_プロダクトID.conf(メトリック定義ファイル)
metrics_プロダクトID.conf.model(メトリック定義ファイルのモデルファイル)
格納先
- Windows
-
-
物理ホストの場合
JP1/IM2のインストール先フォルダ\conf\imdd\plugin\jp1pfm
-
論理ホストの場合
環境ディレクトリ\jp1imm\conf\imdd\plugin\jp1pfm
-
- UNIX
-
-
物理ホストの場合
/etc/opt/jp1imm/conf/imdd/plugin/jp1pfm/
-
論理ホストの場合
環境ディレクトリ/jp1imm/conf/imdd/plugin/jp1pfm/
-
定義情報の反映時期
メトリック定義ファイルを保存すると,すぐに定義情報が反映されます。
変更手順
メトリック定義ファイルを変更する手順を,次に示します。
-
テキストエディターなどで,metrics_プロダクトID.confファイルを開く。
-
metrics_プロダクトID.confファイルを編集する。
-
metrics_プロダクトID.confファイルを保存して閉じる。
-
編集したファイルの形式が正しいかを確認する。
次のどちらかの方法で確認します。
-
JP1/IM2の統合オペレーション・ビューアーで,追加・変更したすべてのメトリックのトレンド情報をチャートに表示する。
-
JP1/IM2のメトリック一覧取得APIと時系列データ取得APIで,追加・変更したすべてのメトリックのパフォーマンスデータを取得する。
編集したファイルの形式が正しい場合は,追加・変更したメトリックのトレンド情報を表示または取得できます。
編集したファイルの形式に誤りがある場合は,エラーメッセージが表示または返却されるため,メッセージの対処方法に従ってmetrics_プロダクトID.confファイルを修正し,再度トレンド情報を表示または取得してください。
JP1/IM2の統合オペレーション・ビューアーの操作方法,およびREST API(メトリック一覧取得APIと時系列データ取得API)の使用方法については,JP1/IM2のマニュアルまたはドキュメントを参照してください。
-
- 注意事項
-
JP1/IM2の統合オペレーション・ビューアーまたはREST APIによるトレンド情報の表示または取得と,metrics_プロダクトID.confファイルの保存のタイミングが重なった場合,正常にファイルが読めずにエラーメッセージが表示されることがあります。この場合は,再度トレンド情報を表示または取得してください。
設定項目
メトリック定義ファイルは,次の表に示す形式で作成します。
項目 |
形式 |
---|---|
フォーマット |
JSON |
文字コード |
UTF-8 |
改行コード |
次のどれか
|
1ファイルに定義できるメトリック数 |
1〜100 |
メトリック定義ファイルのJSONの形式を次に示します。メトリック定義ファイルには,メトリックの情報を配列で指定します。配列の要素である1つのオブジェクトに1つのメトリックの情報を記述します。
[ { "name":"メトリック名", "default":デフォルトの選択状態, "resource_en":{ "category":"メトリックのカテゴリ(英語)", "label":"メトリックの表示名(英語)", "description":"メトリックの説明(英語)", "unit":"メトリックの単位(英語)" }, "resource_ja":{ "category":"メトリックのカテゴリ(日本語)", "label":"メトリックの表示名(日本語)", "description":"メトリックの説明(日本語)", "unit":"メトリックの単位(日本語)" }, "recordId":"レコードID", "fieldId":"フィールドID", "filter": [ { "fieldId":"フィルター対象とするフィールドID", "operator":"比較演算子", "value":"パフォーマンスデータと比較する値", }, ・・・ ], "summarizationRule":"要約ルール" }, ・・・ ]
メトリック定義ファイルで設定する項目を,次の表に示します。
メンバ名 |
省略可否 |
型 |
設定する値 |
|
---|---|---|---|---|
name |
× |
string |
メトリック名を設定します。 1〜255文字で,次に示す文字を指定できます。
メトリック名は,メトリック定義ファイル内で一意にしてください。 |
|
default |
○ |
boolean |
デフォルトの選択状態を設定します。 デフォルトのメトリックにするかどうかを指定します。
省略時はデフォルトのメトリックにしません。 1つのメトリック定義ファイルにつき,「true」を設定できるメトリック数は0〜10個です。 |
|
resource_en |
× |
object |
メトリックのリソース情報(英語)を設定します。 |
|
category |
○ |
string |
メトリックのカテゴリ(英語)を設定します。 1〜255文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 省略時はメトリックのカテゴリを設定しません。 |
|
label |
○ |
string |
メトリックの表示名(英語)を設定します。 1〜255文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 省略時は[統合オペレーション・ビューアー]画面の[トレンド]タブのメトリックの表示名にnameメンバの設定内容を使用します。また,メトリック一覧取得APIでメトリックの表示名が返却されません。 |
|
description |
○ |
string |
メトリックの説明(英語)を設定します。 1〜1,023文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 JP1/IM2の統合オペレーション・ビューアーで表示する場合,使用するWebブラウザによっては,すべての文字が表示されないことがあります。 省略時は[統合オペレーション・ビューアー]画面の[トレンド]タブにメトリックの説明が表示されません。また,メトリック一覧取得APIでメトリックの説明が返却されません。 |
|
unit |
× |
string |
メトリックの単位(英語)を設定します。 1〜255文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 |
|
resource_ja |
○ |
object |
メトリックのリソース情報(日本語)を設定します。 省略時はresource_enの設定内容を使用します。 |
|
category |
○ |
string |
メトリックのカテゴリ(日本語)を設定します。 1〜255文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 省略時はreseource_enのcategoryの設定内容を使用します。 |
|
label |
○ |
string |
メトリックの表示名(日本語)を設定します。 1〜255文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 省略時はreseource_enのlabelの設定内容を使用します。 |
|
description |
○ |
string |
メトリックの説明(日本語)を設定します。 1〜1,023文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 JP1/IM2の統合オペレーション・ビューアーで表示する場合,使用するWebブラウザによっては,すべての文字が表示されないことがあります。 省略時はreseource_enのdescriptionの設定内容を使用します。 |
|
unit |
○ |
string |
メトリックの単位(日本語)を設定します。 1〜255文字で,制御文字(0x00〜0x1F,0x7F〜0x9F)を除く文字を指定します。 省略時はreseource_enのunitの設定内容を使用します。 |
|
recordId |
× |
string |
レコードIDを設定します。 メトリックに対応するパフォーマンスデータのレコードIDを指定します。 PIレコードタイプまたはPDレコードタイプのレコードIDを指定できます。PLレコードタイプおよびPAレコードタイプのレコードIDは指定できません。 |
|
fieldId |
× |
string |
フィールドIDを設定します。 メトリックに対応するパフォーマンスデータのフィールドIDを指定します。フィールドIDは次の形式で指定します。 レコードID_フィールドのPFM - Manager名 フィールドのデータ型は数値(time_tを除く)である必要があります。そうでない場合,トレンド情報が表示されません。また,時系列データ取得APIでパフォーマンスデータが返却されません。 |
|
filter |
○ |
object[] |
Storeデータベースからパフォーマンスデータを取得する時のフィルター条件を配列で設定します。 設定したすべてのフィルター条件に合致するパフォーマンスデータを取得します。 省略時,または0個のフィルター条件を指定したときは,フィルター条件による絞り込みを行いません。 |
|
fieldId |
× |
string |
フィルター対象とするフィールドIDを設定します。 フィールドIDは次の形式で指定します。 レコードID_フィールドのPFM - Manager名 |
|
operator |
○ |
string |
比較演算子を設定します。 次のどれかを指定します。
省略時は「=」が指定されたとみなします。 |
|
value |
× |
string |
パフォーマンスデータと比較する値を設定します。 値はPFM - AgentまたはPFM - RMのマニュアルに記載されている形式に合わせて指定します。 2,048バイト以内で,制御文字(0x00〜0x1F,0x7F〜0x9F)および「( ) [ ] < > = "」を除く文字を指定します。 次に示す設定範囲で指定してください。
|
|
summarizationRule |
○ |
string |
要約ルールを設定します。 トレンド情報の表示または時系列データ取得APIで,指定条件のPerformance Managementのパフォーマンスデータが,インスタンス当たりのデータ数の上限を超える場合の,要約ルール※1を指定します。 次のどれかを指定します(小文字だけが使用できます)。
省略時は要約せず,日時が新しい方のデータを上限値まで表示または返却します。 |
- 注※1
-
要約の対象は,隣り合うn個のデータです。nはデータ数/上限数の計算結果を小数点以下で切り上げた数値です。要約した場合の日時は,要約対象の中で最も新しい値とします。
要約の例を,次に示します。
- (例1)データ数6,上限数5,要約ルール「average」で要約した場合
-
nの値が2となるため,隣り合う2個のデータの値を要約して平均した値にします。
Performance Managementのパフォーマンスデータ
JP1/PFMプラグインで要約したデータ
日時
データ
日時
データ
2019/01/01 00:00:00
1
2019/01/01 00:01:00
1.5
2019/01/01 00:01:00
2
2019/01/01 00:02:00
3
2019/01/01 00:03:00
3.5
2019/01/01 00:03:00
4
2019/01/01 00:04:00
5
2019/01/01 00:05:00
5.5
2019/01/01 00:05:00
6
- (例2)データ数8,上限数8,要約ルール「sum」で要約した場合
-
nの値が3となるため,隣り合う3個のデータの値を要約して合計した値にします。3で割り切れずに余った2個のデータに対しては,余った2個のデータの値を要約して合計した値にします。
Performance Managementのパフォーマンスデータ
JP1/PFMプラグインで要約したデータ
日時
データ
日時
データ
2019/01/01 00:00:00
1
2019/01/01 00:02:00
6
2019/01/01 00:01:00
2
2019/01/01 00:02:00
3
2019/01/01 00:03:00
4
2019/01/01 00:05:00
15
2019/01/01 00:04:00
5
2019/01/01 00:05:00
6
2019/01/01 00:06:00
7
2019/01/01 00:07:00
15
2019/01/01 00:07:00
8
- 注※2
-
PIレコードタイプのレコードでは,要約されたデータがStoreデータベースに格納されます。レコードの要約ルールが「AVG」でメトリックの要約ルールが「average」の場合,平均値の平均値を計算します。
収集間隔を変更していない場合は問題ありませんが,収集間隔を変更していて,要約対象に収集間隔が異なるデータが存在する場合は,正しい平均値でないことに注意してください。
- 注※3
-
要約対象データに指定できる値の最大値と最小値は,それぞれ1.797E308と-1.797E308です。要約ルールの「sum」(合計値)または「average」(平均値=合計値/データ数)で計算する際,要約対象データの合計値が最大値以上となるときは「最大値」を合計値として計算し,要約対象データの合計値が最小値以下となるときは「最小値」を合計値として計算します。
定義例
JP1/IM2にWindows版のJP1/Performance Management - Agent Option for Platformのメトリックを追加する場合のメトリック定義ファイルの記述例を,次に示します。この例は,JP1/IM2のインストール時に提供されるデフォルトのメトリック定義ファイル(metrics_T.conf)です。
[ { "name":"cpu_used_rate", "default":true, "resource_en":{ "label":"CPU used rate", "description":"Processor usage. Percentage of elapsed time used by the processor for executing non-idle threads. [Units: %]", "unit":"%" }, "resource_ja":{ "label":"CPU使用率", "description":"プロセッサの使用率。プロセッサが非アイドル状態のスレッドを実行した経過時間の割合。(単位:%)", "unit":"%" }, "recordId":"PI", "fieldId":"PI_PCT_TOTAL_PROCESSOR_TIME", "summarizationRule":"average" }, { "name":"memory_unused", "default":false, "resource_en":{ "label":"Memory unused", "description":"Available size in the physical memory area. The combined total of zero memory, free memory, and standby memory (cached) that can be immediately allocated to a process or be used by the system. [Units: MB]", "unit":"MB" }, "resource_ja":{ "label":"空きメモリ量", "description":"物理メモリー領域の未使用サイズ。プロセスへの割り当て,またはシステムがすぐに利用できるゼロメモリー,空きメモリー,およびスタンバイメモリー(キャッシュ済み)の領域の合計。(単位:メガバイト)", "unit":"メガバイト" }, "recordId":"PI", "fieldId":"PI_AVAILABLE_BYTES", "summarizationRule":"low" }, { "name":"disk_unused", "default":false, "resource_en":{ "label":"Disk unused", "description":"Size of the unused area of the disk. [Units: MB]", "unit":"MB" }, "resource_ja":{ "label":"空きディスク領域", "description":"ディスクの未使用領域のサイズ。(単位:メガバイト)", "unit":"メガバイト" }, "recordId":"PI_LOGD", "fieldId":"PI_LOGD_FREE_MEGABYTES", "summarizationRule":"low" }, { "name":"disk_busy_rate", "default":false, "resource_en":{ "label":"Disk busy rate", "description":"Percentage of time the disk was busy when a read or write request was processed. [Units: %]", "unit":"%" }, "resource_ja":{ "label":"ディスクビジー率", "description":"読み込みおよび書き込み要求の処理でディスクがビジーだった経過時間の割合。(単位:%)", "unit":"%" }, "recordId":"PI_PHYD", "fieldId":"PI_PHYD_PCT_DISK_TIME", "summarizationRule":"average" }, { "name":"network_sent", "default":false, "resource_en":{ "label":"Network sent", "description":"Rate at which packets were sent throughthe network interface. [Units: packets/second]", "unit":"packets/second" }, "resource_ja":{ "label":"ネットワークの送信速度", "description":"ネットワークインターフェースで送信されるパケットの割合。(単位:パケット/秒)", "unit":"パケット/秒" }, "recordId":"PI_NETI", "fieldId":"PI_NETI_PACKETS_SENT_PER_SEC", "summarizationRule":"average" }, { "name":"network_received", "default":false, "resource_en":{ "label":"Network received", "description":"Rate at which packets were receivedthrough the network interface. [Units: packets/second]", "unit":"packets/second" }, "resource_ja":{ "label":"ネットワークの受信速度", "description":"ネットワークインターフェースで受信されるパケットの割合。(単位:パケット/秒)", "unit":"パケット/秒" }, "recordId":"PI_NETI", "fieldId":"PI_NETI_PACKETS_RECEIVED_PER_SEC", "summarizationRule":"average" } ]