Tuning Manager Software 運用管理ガイド

8.4.2 jpcasrec update

形式
jpcasrec update     <入力ファイル>
機能

jpcasrec updateコマンドは，エージェントに接続しStoreデータベースの記録方法に関する定義情報を変更します。変更する定義情報は，コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。1つのパラメーターファイルに複数のStoreデータベース定義情報を指定し，一括して変更できます。

実行権限

Windowsの場合：

Administrators権限を持つユーザー

SolarisおよびLinuxの場合：

rootユーザー権限を持つユーザー

格納先ディレクトリ

Windowsの場合：

<Tuning Manager serverのインストール先フォルダ>\PerformanceReporter\tools\

Solarisの場合：

/opt/HiCommand/TuningManager/PerformanceReporter/tools/

Linuxの場合：

<Tuning Manager serverのインストール先ディレクトリ>/PerformanceReporter/tools/

オプション

jpcasrec updateコマンドのオプションを次の表に示します。

表8-18 jpcasrec updateコマンドのオプション一覧

オプション目的値必須/任意注記

<入力ファイル> Storeデータベースの記録方法定義情報を変更するための，XML形式のパラメーターファイルを指定します。後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名，相対ファイルパス名，ファイル名を指定でき，絶対ファイルパス名以外の場合，カレントディレクトリを基点とします。必須なし

パラメーターファイルの形式

XMLタグ仕様

表8-19 agent-store-db-record-definition

種別説明

意味 Storeデータベース記録方法変更定義情報のルートタグ

指定可能値なし

省略不可

属性なし

親要素 pr-cli-parameters

子要素 service（複数指定できます）

表8-20 service

種別説明

意味エージェントを特定するサービスを指定します。

指定可能値なし

省略不可

属性 id サービスID（4～258文字）
1桁目はエージェントのプロダクトIDを指定します。プロダクトIDについては，各PFM - Agentマニュアルを参照してください。
2桁目は「A」（Agent Collector）を指定します。

親要素 agent-store-db-record-definition

子要素 record（省略できません。複数指定できます）

表8-21 record

種別説明

意味変更するレコードIDを指定します。

指定可能値なし

省略不可

属性 id レコードID（1～8文字）。各PFM - Agentのマニュアルに記述されているレコードIDを指定します。

親要素 service

子要素^※ log（1recordに1回だけ指定できます。省略できます）

collection-interval（1recordに1回だけ指定できます。省略できます）

collection-offset（1recordに1回だけ指定できます。省略できます）

logif（1recordに1回だけ指定できます。省略できます）

注※

子要素を省略した場合，該当項目は更新しません。また，子要素を指定する場合は，記載順に指定します。

表8-22 log

種別説明

意味 Storeデータベースに記録するパフォーマンスデータを収集するかしないかを指定します。

指定可能値半角英字

「Yes」：パフォーマンスデータを収集します（ただし，「Collection Interval=0」の場合，収集しません）。

「No」：パフォーマンスデータを収集しません。

ただし，大文字・小文字どちらでも指定できます。
注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。

PFM - Agentが求める指定条件

Tuning Manager serverが求める指定条件

PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。
Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。

省略可（省略時はlogを更新しません）

属性なし

親要素 record

子要素なし

表8-23 collection-interval

種別説明

意味パフォーマンスデータの収集間隔を秒数で指定します。

指定可能値次の半角数字

0

60～3,600のうち60の倍数かつ3,600の約数

3,600～86,400のうち3,600の倍数かつ86,400の約数

上記の数値以外を指定した場合，パフォーマンスデータが正しく格納されないことがあります。また，0を指定した場合，パフォーマンスデータは収集されません。
注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。

PFM - Agentが求める指定条件

Tuning Manager serverが求める指定条件

PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。
Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。

省略可（省略時はcollection-intervalを更新しません）

属性なし

親要素 record

子要素なし

表8-24 collection-offset

種別説明

意味パフォーマンスデータの収集処理のタイミングをずらして開始する場合のオフセット値を秒数で指定します。

指定可能値半角数字
0～32,767（ただし，Collection Intervalで指定した値の範囲内を指定してください）
注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。

PFM - Agentが求める指定条件

Tuning Manager serverが求める指定条件

PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。
Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。

省略可（省略時はcollection-offsetを更新しません）

属性なし

親要素 record

子要素なし

表8-25 logif

種別説明

意味パフォーマンスデータをStoreデータベースに記録する判断条件を指定します。

指定可能値なし
注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。

PFM - Agentが求める指定条件

Tuning Manager serverが求める指定条件

PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。
Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。

省略可（省略時はlogifを更新しません）

属性 delete "yes"（この属性の指定時は，子要素の指定は無視して登録されているexpressionを削除します。この属性の省略時は，子要素の指定に従って判断条件を登録します）

親要素 record

子要素 expression（複数指定できます。省略できます）

and（複数のexpressionが存在する場合に複数指定できます。省略できます）

or（複数のexpressionが存在する場合に複数指定できます。省略できます）

表8-26 expression

種別説明

意味パフォーマンスデータをStoreデータベースに記録する判断条件を指定します。

指定可能値条件式は「<フィールド> <条件> "<値>"」の形式で指定します。フィールド・条件・値の区切りに空白は使用できません。

右辺にフィールドを指定できません。

expression属性を複数指定する場合は，2つのexpression属性を，論理演算子を表すタグ「and」または「or」で囲って指定する2項演算子の形式とし，2項演算子のネストを許します。多項演算の指定はできません。

条件以外に等号，不等号の文字を使用する場合は，直前に「\」を指定します。「\」を指定する場合は，「\\」を指定します。

<フィールド>
フィールドは，レコードに含まれるフィールドを「PFM - Manager名」で指定します。PFM - Manager名については，各PFM - Agentマニュアルのレコードの説明を参照してください。
<条件>
条件に指定する値を次に示します。

「=」：フィールドの値と"<値>"が等しい。

「<」：フィールドの値が"<値>"より小さい。

「<=」：フィールドの値が"<値>"より小さいか等しい。

「>」：フィールドの値が"<値>"より大きい。

「>=」：フィールドの値が"<値>"より大きいか等しい。

「<>」：フィールドの値と"<値>"が異なる。

XMLの表記として「<」は「<」，「>」は「>」を指定します。
文字列フィールドの場合は，ASCIIコードの昇順に比較します。大文字と小文字は区別されます。
"<値>"
各PFM - Agentのマニュアルに記述されているフィールドの形式に合わせ指定します。次に示す設定範囲で指定します。

文字（指定値をそのまま設定）

整数（Integerで許される範囲の値）

小数（Doubleで許される範囲の値で，小数点以下が4桁以上の場合，IEEE754規格のRound to nearestの仕様^※1に従って4桁に丸めます）

日付（時刻を"HH:mm:ss"固定の形式で指定します）

値に制御文字および「( ) [ ] < > = ''」の文字は指定できません。指定した場合はエラーになります。
文字列を指定する場合は，ワイルドカード文字を使用できます。
使用できるワイルドカード文字を次に示します。

*：任意の0文字以上の文字列

?：任意の1文字

\：「*」，「?」および「\」をワイルドカードではなく文字として扱う場合
例えば，「\*」と指定した場合は，文字「*」として扱います。^※2

省略不可

属性なし

親要素 logif

and

or

子要素なし

注※1

IEEE754規格のRound to nearestの仕様を次に示します。

丸める対象となる数と2つの近似値との距離を比べて，丸める対象となる数に最も近い近似値に丸めます。

丸める対象となる数と2つの近似値との距離が同じ場合，2つの近似値を2進表現していちばん下の桁が「0」となる近似値に丸めます。

注※2

「\」の次にワイルドカードを含む文字列が値として指定された場合に，指定したフィールドの文字列と完全一致すると，値の判定は真となります。

例えば，値に「\*abc」と指定した場合，対象のフィールドに「\*abc」と格納されているときも，「*abc」と格納されているときも真と判定されます。

表8-27 and

種別説明

意味 expressionで指定した論理式のAND演算を指定します。

指定可能値なし

省略可

属性なし

親要素 logif

and

or

子要素 expression（複数指定できます。省略できます）

and（複数のexpressionが存在する場合に複数指定できます。省略できます）

or（複数のexpressionが存在する場合に複数指定できます。省略できます）

表8-28 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="0100">
<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>
            <logif>
                <and>
                  <and>
                     <expression>RECORD_TIME="10:26:50"</expression>
                     <expression>UNIQUE_KEYS&gt;="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>
パラメーターの記述を定義する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))>
注意事項
各タグの指定値は，「6.2.2 パフォーマンスデータの記録方法の設定」で説明されている注意に従って設定してください。

サービスID，レコードID，各レコードIDのフィールド名，指定できる値の範囲については，各PFM - Agentのマニュアルを参照してください。

サービスID，レコードIDごとに変更できるパラメーターが異なります。詳細は各PFM - Agentのマニュアルを参照してください。

指定するサービスID，レコードIDによって，Sync Collection Withの扱いになっているレコードがあります。その場合，Collection intervalおよびCollection offsetは指定できません。詳細は各PFM - Agentのマニュアルを参照してください。

指定したサービス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&gt;"100"</expression>
<expression>RECORD_TIME&gt;"11:22:33"</expression>
戻り値

0 正常終了しました。

1 コマンドライン形式不正です。

2 コマンドを実行したOSユーザーに実行権限がありません。

3 出力ファイルの作成に失敗しました。

5 DTDファイルと不整合のためパラメーターを解析できません。

10 1件以上のStoreデータベース定義の更新に失敗しました。

100 環境が不正です。

200 メモリーエラーが発生しました。

202 ファイルアクセスエラーが発生しました。

222 通信処理でエラーが発生しました。

255 予期しないエラーが発生しました。

使用例

Storeデータベースの記録方法に関する定義内容を記述したパラメーターファイル（asrec_update.xml）を指定する場合のコマンド実行例を次に示します。
jpcasrec  update  asrec_update.xml
出力例

コマンド処理の詳細情報を標準出力，標準エラー出力，トレースログファイルに出力します。ログ仕様については，「7.3.4 Performance Reporterのログ」を参照してください。

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

オプション	目的	値	必須/任意	注記
`<入力ファイル>`	Storeデータベースの記録方法定義情報を変更するための，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データベースに記録するパフォーマンスデータを収集するかしないかを指定します。
指定可能値	半角英字「Yes」：パフォーマンスデータを収集します（ただし，「Collection Interval=0」の場合，収集しません）。「No」：パフォーマンスデータを収集しません。ただし，大文字・小文字どちらでも指定できます。注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。 PFM - Agentが求める指定条件 Tuning Manager serverが求める指定条件 PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。 Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。
省略	可（省略時はlogを更新しません）
属性	なし
親要素	record
子要素	なし

種別	説明
意味	パフォーマンスデータの収集間隔を秒数で指定します。
指定可能値	次の半角数字 0 60～3,600のうち60の倍数かつ3,600の約数 3,600～86,400のうち3,600の倍数かつ86,400の約数上記の数値以外を指定した場合，パフォーマンスデータが正しく格納されないことがあります。また，0を指定した場合，パフォーマンスデータは収集されません。注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。 PFM - Agentが求める指定条件 Tuning Manager serverが求める指定条件 PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。 Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。
省略	可（省略時はcollection-intervalを更新しません）
属性	なし
親要素	record
子要素	なし

種別	説明
意味	パフォーマンスデータの収集処理のタイミングをずらして開始する場合のオフセット値を秒数で指定します。
指定可能値	半角数字 0～32,767（ただし，Collection Intervalで指定した値の範囲内を指定してください）注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。 PFM - Agentが求める指定条件 Tuning Manager serverが求める指定条件 PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。 Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。
省略	可（省略時はcollection-offsetを更新しません）
属性	なし
親要素	record
子要素	なし

種別	説明
意味	パフォーマンスデータをStoreデータベースに記録する判断条件を指定します。
指定可能値	なし注意：PFM - Agentが収集したパフォーマンスデータをTuning Manager serverに表示させるためには，このタグに，次の両方の条件を満たした値を指定する必要があります。 PFM - Agentが求める指定条件 Tuning Manager serverが求める指定条件 PFM - Agentが求める指定条件については，各PFM - Agentのマニュアルの，レコードの記載形式について説明している個所を参照してください。 Tuning Manager serverが求める指定条件については，「6.1.5 ポーリングを実行するための準備」を参照してください。
省略	可（省略時はlogifを更新しません）
属性	delete	"yes"（この属性の指定時は，子要素の指定は無視して登録されているexpressionを削除します。この属性の省略時は，子要素の指定に従って判断条件を登録します）
親要素	record
子要素	expression（複数指定できます。省略できます）
and（複数のexpressionが存在する場合に複数指定できます。省略できます）
or（複数のexpressionが存在する場合に複数指定できます。省略できます）

種別	説明
意味	パフォーマンスデータをStoreデータベースに記録する判断条件を指定します。
指定可能値	条件式は「`<フィールド>` `<条件>` `"<値>"`」の形式で指定します。フィールド・条件・値の区切りに空白は使用できません。右辺にフィールドを指定できません。 expression属性を複数指定する場合は，2つのexpression属性を，論理演算子を表すタグ「and」または「or」で囲って指定する2項演算子の形式とし，2項演算子のネストを許します。多項演算の指定はできません。条件以外に等号，不等号の文字を使用する場合は，直前に「\」を指定します。「\」を指定する場合は，「\\」を指定します。 `<フィールド>` フィールドは，レコードに含まれるフィールドを「PFM - Manager名」で指定します。PFM - Manager名については，各PFM - Agentマニュアルのレコードの説明を参照してください。 `<条件>` 条件に指定する値を次に示します。「=」：フィールドの値と`"<値>"`が等しい。「<」：フィールドの値が`"<値>"`より小さい。「<=」：フィールドの値が`"<値>"`より小さいか等しい。「>」：フィールドの値が`"<値>"`より大きい。「>=」：フィールドの値が`"<値>"`より大きいか等しい。「<>」：フィールドの値と`"<値>"`が異なる。 XMLの表記として「<」は「<」，「>」は「>」を指定します。文字列フィールドの場合は，ASCIIコードの昇順に比較します。大文字と小文字は区別されます。 `"<値>"` 各PFM - Agentのマニュアルに記述されているフィールドの形式に合わせ指定します。次に示す設定範囲で指定します。文字（指定値をそのまま設定）整数（Integerで許される範囲の値）小数（Doubleで許される範囲の値で，小数点以下が4桁以上の場合，IEEE754規格のRound to nearestの仕様^※1に従って4桁に丸めます）日付（時刻を"HH:mm:ss"固定の形式で指定します）値に制御文字および「( ) [ ] < > = ''」の文字は指定できません。指定した場合はエラーになります。文字列を指定する場合は，ワイルドカード文字を使用できます。使用できるワイルドカード文字を次に示します。：任意の0文字以上の文字列 ?：任意の1文字 \：「」，「?」および「\」をワイルドカードではなく文字として扱う場合例えば，「\」と指定した場合は，文字「」として扱います。^※2
省略	不可
属性	なし
親要素	logif
and
or
子要素	なし

種別	説明
意味	expressionで指定した論理式のAND演算を指定します。
指定可能値	なし
省略	可
属性	なし
親要素	logif
and
or
子要素	expression（複数指定できます。省略できます）
and（複数のexpressionが存在する場合に複数指定できます。省略できます）
or（複数のexpressionが存在する場合に複数指定できます。省略できます）

種別	説明
意味	expressionで指定した論理式のOR演算を指定します。
指定可能値	なし
省略	可
属性	なし
親要素	logif
and
or
子要素	expression（複数指定できます。省略できます）
and（複数のexpressionが存在する場合に複数指定できます。省略できます）
or（複数のexpressionが存在する場合に複数指定できます。省略できます）

[目次] [前へ] [次へ]

0	正常終了しました。
1	コマンドライン形式不正です。
2	コマンドを実行したOSユーザーに実行権限がありません。
3	出力ファイルの作成に失敗しました。
5	DTDファイルと不整合のためパラメーターを解析できません。
10	1件以上のStoreデータベース定義の更新に失敗しました。
100	環境が不正です。
200	メモリーエラーが発生しました。
202	ファイルアクセスエラーが発生しました。
222	通信処理でエラーが発生しました。
255	予期しないエラーが発生しました。