jpcasrec update
形式
jpcasrec update [-mx 最大ヒープサイズ] [-ms 初期ヒープサイズ] 入力ファイル名
機能
jpcasrec updateコマンドは,エージェントに接続しStoreデータベースの記録方法に関する定義情報を変更するコマンドです。変更する定義情報は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。1つのパラメーターファイルに複数のStoreデータベース定義情報を指定し,一括して変更できます。
コマンドを実行できるホスト
PFM - Web Console
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
また,コマンドを実行するためには,事前にPerformance Managementに対する管理ユーザー権限※のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については,「jpcmkkey」コマンドを参照してください。
- 注※
-
Performance ManagementユーザーまたはJP1ユーザーが必要とする,Performance Managementに対する実行権限です。
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pcwebcon/tools/
引数
-mx 最大ヒープサイズ
java.exeの最大ヒープサイズをメガバイト単位で指定します。デフォルトは,128メガバイトです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-
1〜2,048の整数
-
「-mxの指定値 >= -msの指定値」
-ms 初期ヒープサイズ
java.exeの初期ヒープサイズをメガバイト単位で指定します。デフォルトは,32メガバイトです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-
1〜2,048の整数
-
「-mxの指定値 >= -msの指定値」
入力ファイル名
Storeデータベースの記録方法定義情報を変更するための,XML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名を指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。
パラメーターファイルの形式
XMLタグ仕様
-
agent-store-db-record-definition
種別
説明
意味
Storeデータベース記録方法変更定義情報のルートタグ
指定可能値
なし
省略
不可
属性
なし
親要素
pr-cli-parameters
子要素
service(複数指定できる)
-
service
種別
説明
意味
エージェントを特定するサービスを指定する。
指定可能値
なし
省略
不可
属性
id
サービスID(4〜258文字)
1桁目はエージェントのプロダクトIDを指定する。プロダクトIDについては,各PFM - AgentまたはPFM - RMマニュアルを参照。
2桁目は「A」(Agent CollectorまたはRemote Monitor Collector)を指定する。
親要素
agent-store-db-record-definition
子要素
record(省略できない。複数指定できる)
-
record
種別
説明
意味
変更するレコードIDを指定する。
指定可能値
なし
省略
不可
属性
id
レコードID(1〜8文字)。各PFM - AgentまたはPFM - RMマニュアルに記述されているレコードIDを指定する。
親要素
service
子要素※
log(1recordに1回だけ指定できる。省略できる)
collection-interval(1recordに1回だけ指定できる。省略できる)
collection-offset(1recordに1回だけ指定できる。省略できる)
logif(1recordに1回だけ指定できる。省略できる)
-
log
種別
説明
意味
Storeデータベースに記録するかしないかを指定する。
指定可能値
半角英字
-
「Yes」:Storeデータベースに記録する。
-
「No」:Storeデータベースに記録しない。
ただし,大文字・小文字どちらでも指定できる。
省略
可(省略時はlogを更新しない)
属性
なし
親要素
record
子要素
なし
-
-
collection-interval
種別
説明
意味
パフォーマンスデータの収集間隔を秒数で指定する。
指定可能値
半角数字
0〜2,147,483,647(0指定時は,パフォーマンスデータを収集しない)
省略
可(省略時はcollection-intervalを更新しない)
属性
なし
親要素
record
子要素
なし
-
collection-offset
種別
説明
意味
パフォーマンスデータの収集を開始するオフセットを秒数で指定する。
指定可能値
半角数字
0〜32,767(0指定時は,パフォーマンスデータの収集を同時に開始する)
省略
可(省略時はcollection-offsetを更新しない)
属性
なし
親要素
record
子要素
なし
-
realtime-report-data-collection-mode
種別
説明
意味
履歴データの収集をリアルタイムレポートの表示処理より優先する場合に,動作モードを指定する※。
指定可能値
半角英字
-
「Reschedule」:再スケジュールモード
-
「Temporary Log」:一時保存モード
ただし,大文字・小文字どちらでも指定できる。
省略
可(省略時はrealtime-report-data-collection-modeを更新しない)
属性
なし
親要素
record
子要素
なし
-
-
logif
種別
説明
意味
パフォーマンスデータをStoreデータベースに記録する判断条件を指定する。
指定可能値
なし
省略
可(省略時はlogifを更新しない)
属性
delete
"yes"(この属性の指定時は,子要素の指定は無視して登録されているexpressionを削除する。この属性の省略時は,子要素の指定に従って判断条件を登録する)
親要素
record
子要素
expression(複数指定できる。省略できる)
and(複数のexpressionがある場合に複数指定できる。省略できる)
or(複数のexpressionがある場合に複数指定できる。省略できる)
-
expression
種別
説明
意味
パフォーマンスデータをStoreデータベースに記録する判断条件を指定する。
指定可能値
条件式は「フィールド 条件 "値"」の形式で指定する。フィールド・条件・値の区切りに空白は使用できない。
-
右辺にフィールドは指定できない。
-
expression属性を複数指定する場合は,2つのexpression属性を,論理演算子を表すタグ「and」または「or」で囲って指定する2項演算子の形式とし,2項演算子のネストを許す。多項演算の指定はできない。
-
条件以外に等号,不等号の文字を使用する場合は,直前に「\」を指定する。「\」を指定する場合は,「\\」を指定する。
フィールド
-
フィールドは,レコードに含まれるフィールドを「PFM - Manager名」で指定する。PFM - Manager名については,各PFM - AgentまたはPFM - RMマニュアルのレコードの説明を参照。
条件
条件に指定する値を次に示す。
-
「=」:フィールドの値と"値"が等しい。
-
「<」:フィールドの値が"値"より小さい。
-
「<=」:フィールドの値が"値"より小さいか等しい。
-
「>」:フィールドの値が"値"より大きい。
-
「>=」:フィールドの値が"値"より大きいか等しい。
-
「<>」:フィールドの値と"値"が異なる。
XMLの表記として「<」は「<」,「>」は「>」を指定する。
文字列フィールドの場合は,ASCIIコードの昇順に比較する。
"値"
各PFM - AgentまたはPFM - RMマニュアルに記述されているフィールドのデータ型に合わせ指定する。次に示す設定範囲で指定する。
-
文字(指定値をそのまま設定)
-
整数(Integerで許される範囲の値)
-
小数(Doubleで許される範囲の値で,小数点以下が4桁以上の場合,IEEE754規格のRound to nearestの仕様※に従って4桁に丸める)
-
日付(時刻を"HH:mm:ss"固定の形式で指定する)
値に制御文字および「( ) [ ] < > = "」の文字は指定できない。指定した場合はエラーになる。
省略
不可
属性
なし
親要素
logif
and
or
子要素
なし
-
-
and
種別
説明
意味
expressionで指定した論理式のAND演算を指定する。
指定可能値
なし
省略
可
属性
なし
親要素
logif
and
or
子要素
expression(複数指定できる。省略できる)
and(複数のexpressionがある場合に複数指定できる。省略できる)
or(複数のexpressionがある場合に複数指定できる。省略できる)
-
or
種別
説明
意味
expressionで指定した論理式のOR演算を指定する。
指定可能値
なし
省略
可
属性
なし
親要素
logif
and
or
子要素
expression(複数指定できる。省略できる)
and(複数のexpressionがある場合に複数指定できる。省略できる)
or(複数のexpressionがある場合に複数指定できる。省略できる)
パラメーターファイルの記述例を次に示します。
パラメーターファイル記述例
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "asrec_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-record-definition> <service id="TA1host1"> <record id="PD_CIND"> <log>Yes</log> <collection-interval>60</collection-interval> <collection-offset>0</collection-offset> <realtime-report-data-collection-mode>Temporary Log</realtime-report-data-collection-mode> <logif> <and> <and> <expression>RECORD_TIME="10:26:50"</expression> <expression>UNIQUE_KEYS>="40"</expression> </and> <or> <expression>INSTANCE="abc"</expression> <expression>INSTANCE="xyz"</expression> </or> </and> </logif> </record> <record id="PD_CINF"> <log>Yes</log> <collection-interval>300</collection-interval> <collection-offset>10</collection-offset> <logif delete="yes"/> </record> <record id="PD_DEV"> <log>No</log> </record> </service> </agent-store-db-record-definition> </pr-cli-parameters>
注意事項
-
このコマンドは,実行時にPFM - Managerに対する認証が必要です。認証用のキーファイルを作成していない場合は,コマンドを実行する前に,jpcmkkeyコマンドで認証用のキーファイルを作成してください。各タグの指定値は,各PFM - AgentまたはPFM - RMマニュアルの,パフォーマンスデータの収集の設定に関する注意に従って設定してください。
-
サービスID,レコードID,各レコードIDのフィールド名,指定できる値の範囲については,各PFM - AgentまたはPFM - RMマニュアルを参照してください。
-
サービスID,レコードIDごとに変更できるパラメーターが異なります。詳細は各PFM - AgentまたはPFM - RMマニュアルを参照してください。
-
指定するサービスID,レコードIDによって,Sync Collection Withの扱いになっているレコードがあります。その場合,Collection intervalおよびCollection offsetは指定できません。詳細は各PFM - AgentまたはPFM - RMマニュアルを参照してください。
-
指定したサービスIDが,エージェントのプロダクト以外の場合はエラーとします。
-
同一サービスIDを複数回指定した場合,エラーとします。
-
同一レコードIDを複数回指定した場合,エラーとします。
-
複数のStoreデータベース記録方法定義を,サービスID単位ごとに連続登録しているとき,どれかの定義登録が失敗すると,コマンドはその定義の登録を中断し,ほかのサービスID単位の定義がある場合はそれを登録します。
-
<logif>タグの<and>と<or>タグの下には2つの要素しか指定できません。
記述例を次に示します。
<and> <expression>式1</expression> <or> <expression>式2</expression> <or> <expression>式3</expression> <or> <expression>式4</expression> <expression>式5</expression> </or> </or> </or> </and>
<expression>タグに指定する式の記述例を次に示します。
<expression>SEGMENTS_RETRANSMITTED_PER_SEC>"100"</expression> <expression>RECORD_TIME>"11:22:33"</expression>
-
通常,-mxオプションおよび-msオプションを設定する必要はありません。コマンド実行時に,メモリー不足を示すKAVJK0401-Eメッセージが出力された場合は,-mxオプションの最大ヒープサイズに64以上を指定して,再度実行してください。
戻り値
0 |
正常終了した。 |
1 |
コマンドラインの形式が不正である。 |
2 |
コマンドの実行権限がない。 |
3 |
出力ファイルの作成に失敗した。 |
5 |
DTDファイルと不整合のためパラメーターが解析できない。 |
10 |
1件以上のStoreデータベース定義の更新に失敗した。 |
11 |
PFM - Managerへの認証処理に失敗した。または,認証時に指定したユーザーに実行権限がない。 |
100 |
環境が不正である。 |
200 |
メモリーエラーが発生した。 |
202 |
ファイルアクセスエラーが発生した。 |
222 |
通信処理でエラーが発生した。 |
255 |
予期しないエラーが発生した。 |
使用例
Storeデータベースの記録方法に関する定義内容を記述したパラメーターファイル(asrec_update.xml)を指定する場合のコマンド実行例を次に示します。
jpcasrec update asrec_update.xml
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「6. Performance Managementで出力するログ情報」を参照してください。
3つのサービスIDを指定し,1つがエラーとなった場合の標準出力形式を次に示します。serviceタグで指定したサービスIDごとに実行結果を表示します(OKまたはERR)。
標準出力の出力例
jpcasrec update connected to hostname at yyyy MM dd HH:MM:SS.mmm update result OK : TA1host1 update result OK : TA1host2 update result ERR : TA1host3 jpcasrec update disconnected at yyyy MM dd HH:MM:SS.mmm