形式
jpcasrec update [-mx 最大ヒープサイズ]
[-ms 初期ヒープサイズ]
入力ファイル
機能
jpcasrec updateコマンドは,エージェントに接続しStoreデータベースの記録方法に関する定義情報を変更するコマンドです。変更する定義情報は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。一つのパラメーターファイルに複数のStoreデータベース定義情報を指定し,一括して変更できます。
コマンドを実行できるホスト
PFM - Web Console
実行権限
格納先ディレクトリ
引数
-mx 最大ヒープサイズ
java.exeの最大ヒープサイズをMB単位で指定します。デフォルトは,64MBです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-ms 初期ヒープサイズ
java.exeの初期ヒープサイズをMB単位で指定します。デフォルトは,32MBです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
入力ファイル
Storeデータベースの記録方法定義情報を変更するための,XML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名を指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。
パラメーターファイルの形式
XMLタグ仕様
種別 | 説明 |
---|---|
意味 | Storeデータベース記録方法変更定義情報のルートタグ |
指定可能値 | なし |
省略 | 不可 |
属性 | なし |
親要素 | pr-cli-parameters |
子要素 | service(複数指定できます。) |
種別 | 説明 | |
---|---|---|
意味 | エージェントを特定するサービスを指定します。 | |
指定可能値 | なし | |
省略 | 不可 | |
属性 | id | サービスID(4~258文字) 1けた目はエージェントのプロダクトIDを指定します。プロダクトIDについては,各PFM - Agentマニュアルを参照してください。 2けた目は「A」(Agent Collector)を指定します。 |
親要素 | agent-store-db-record-definition | |
子要素 | record(省略できません。複数指定できます。) |
種別 | 説明 | |
---|---|---|
意味 | 変更するレコードIDを指定します。 | |
指定可能値 | なし | |
省略 | 不可 | |
属性 | id | レコードID(1~8文字)。各PFM - Agentのマニュアルに記述されているレコードIDを指定します。 |
親要素 | service | |
子要素※ | log(1recordに1回だけ指定できます。省略できます。) | |
collection-interval(1recordに1回だけ指定できます。省略できます。) | ||
collection-offset(1recordに1回だけ指定できます。省略できます。) | ||
logif(1recordに1回だけ指定できます。省略できます。) |
種別 | 説明 |
---|---|
意味 | Storeデータベースに記録するかしないかを指定します。 |
指定可能値 | 半角英字
|
省略 | 可(省略時はlogを更新しません。) |
属性 | なし |
親要素 | record |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | パフォーマンスデータの収集間隔を秒数で指定します。 |
指定可能値 | 半角数字 0~2,147,483,647(0指定時は,パフォーマンスデータを収集しません。) |
省略 | 可(省略時はcollection-intervalを更新しません。) |
属性 | なし |
親要素 | record |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | パフォーマンスデータの収集を開始するオフセットを秒数で指定します。 |
指定可能値 | 半角数字 0~32,767(0指定時は,パフォーマンスデータの収集を同時に開始します。) |
省略 | 可(省略時はcollection-offsetを更新しません。) |
属性 | なし |
親要素 | record |
子要素 | なし |
種別 | 説明 | |
---|---|---|
意味 | パフォーマンスデータをStoreデータベースに記録する判断条件を指定します。 | |
指定可能値 | なし | |
省略 | 可(省略時はlogifを更新しません。) | |
属性 | delete | "yes"(この属性の指定時は,子要素の指定は無視して登録されているexpressionを削除します。この属性の省略時は,子要素の指定に従って判断条件を登録します。) |
親要素 | record | |
子要素 | expression(複数指定できます。省略できます。) | |
and(複数のexpressionが存在する場合に複数指定できます。省略できます。) | ||
or(複数のexpressionが存在する場合に複数指定できます。省略できます。) |
種別 | 説明 |
---|---|
意味 | パフォーマンスデータをStoreデータベースに記録する判断条件を指定します。 |
指定可能値 | 条件式は「フィールド 条件 "値"」の形式で指定します。フィールド・条件・値の区切りに空白は使用できません。
文字列フィールドの場合は,ASCIIコードの昇順に比較します。
|
省略 | 不可 |
属性 | なし |
親要素 | logif |
and | |
or | |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | expressionで指定した論理式のAND演算を指定します。 |
指定可能値 | なし |
省略 | 可 |
属性 | なし |
親要素 | logif |
and | |
or | |
子要素 | expression(複数指定できます。省略できます。) |
and(複数のexpressionが存在する場合に複数指定できます。省略できます。) | |
or(複数のexpressionが存在する場合に複数指定できます。省略できます。) |
種別 | 説明 |
---|---|
意味 | 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="0100">
<agent-store-db-record-definition>
<service id="TA1host1">
<record id="PD">
<log>Yes</log>
<collection-interval>60</collection-interval>
<collection-offset>0</collection-offset>
<logif>
<expression>PCT_PROCESSOR_TIME>"80.000"</expression>
</logif>
</record>
<record id="PD_PDI">
<log>Yes</log>
<collection-interval>60</collection-interval>
<collection-offset>0</collection-offset>
<logif>
<or>
<expression>PCT_PROCESSOR_TIME>"80.000"</expression>
<and>
<expression>VIRTUAL_BYTES>"102400.000"</expression>
<expression>INSTANCE="*jpc*"</expression>
</and>
</or>
</logif>
</record>
<record id="PD_DEV">
<log>No</log>
</record>
</service>
</agent-store-db-record-definition>
</pr-cli-parameters>
パラメーターの記述を定義するDTDファイルを次に示します。
パラメーターの記述を定義するDTDファイル
<!ELEMENT pr-cli-parameters (agent-store-db-record-definition)>
<!ATTLIST pr-cli-parameters ver (0100) #REQUIRED>
<!ELEMENT agent-store-db-record-definition (service+)>
<!ELEMENT service (record+)>
<!ATTLIST service id CDATA #REQUIRED>
<!ELEMENT record (log?, collection-interval?,
collection-offset?, logif?)>
<!ATTLIST record id CDATA #REQUIRED>
<!ELEMENT log (#PCDATA)>
<!ELEMENT collection-interval (#PCDATA)>
<!ELEMENT collection-offset (#PCDATA)>
<!ELEMENT logif (expression| and| or)?>
<!ATTLIST logif delete CDATA #IMPLIED>
<!ELEMENT expression (#PCDATA)>
<!ELEMENT and ((expression| or| and), (expression| or| and))>
<!ELEMENT or ((expression| or| and), (expression| or| and))>
注意事項
<and>
<expression>式1</expression>
<or>
<expression>式2</expression>
<or>
<expression>式3</expression>
<or>
<expression>式4</expression>
<expression>式5</expression>
</or>
</or>
</or>
</and>
<expression>SEGMENTS_RETRANSMITTED_PER_SEC>"100"</expression>
<expression>RECORD_TIME>"11:22:33"</expression>
戻り値
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
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「3. ログ情報」を参照してください。
三つのサービスIDを指定し,一つがエラーとなった場合の標準出力形式を次に示します。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