5.8.3 jpcuserコマンドの形式

jpcuserコマンドの形式について説明します。

形式

jpcuser レコード名
       -file ユーザー作成データのファイル名1
       [-file ユーザー作成データのファイル名2]...
       [-debug [0|1|2]]

[ ]は,省略できることを示します。|は,複数の項目に対して項目間の区切りを示し,「または」の意味を示します。
機能
ユーザーコマンドによって出力した独自のパフォーマンスデータ(ユーザー作成データ)を,PFM - Agent for Platformが読み取れる形式のデータ(ユーザーデータファイル)に変換するコマンドです。
デバッグログを出力することで,ユーザー作成データの内容が正しいかどうかも確認できます。デバッグログの形式と見方については,「5.8.5 ユーザー作成データの内容が正しいかどうかを確認するためのデバッグログの参照」を参照してください。
このコマンド実行時にエラーが発生した場合は,エラーメッセージがインストール先フォルダ¥agtt¥agent¥jpcuser¥log¥public¥に出力されます。
実行権限
Administrators権限を持つユーザー
格納先ディレクトリ
インストール先フォルダ¥agtt¥agent¥jpcuser¥
引数
コマンドラインの第一引数にはレコード名を指定してください。-fileオプションおよび-debugオプションは,順不同で指定できます。レコード名および-fileオプションは必ず指定してください。-debugオプションは省略できます。
レコード名
パフォーマンスデータを格納するユーザーレコード名を指定します。複数のレコード名を指定することはできません。
  • PD_UPD
  • PD_UPDB
  • PI_UPI
  • PI_UPIB
-file ユーザー作成データのファイル名
ファイル名を1,023バイト以内で指定します。ファイル名は複数指定でき,複数のユーザー作成データファイルを1つのユーザーデータファイルにまとめることができます。
ファイル名にワイルドカードは指定できません。
ファイル名は,カレントディレクトリ(コマンドの実行ディレクトリ)から見た相対パスで指定できます。
ユーザー作成データを複数読み込ませた場合,1つでも警告が発生すれば戻り値は「警告のある正常終了」,1つでもエラーが発生すれば戻り値は「異常終了またはエラー発生」になります。
-debug [0|1|2]
ユーザーデータファイル,およびデバッグログを出力するかどうかを値で指定します。このオプションは,ユーザー作成データの内容が正しいかどうかを確認する目的で使用します。このオプションは,一度だけしか設定できません。
-debug 1を指定した場合は,デバッグだけ行われます。ユーザーレコードを作成したい場合は,-debug 1以外を指定してください。
デバッグログにエラーが出力された場合は,ユーザーコマンドのスクリプトに誤りがあるおそれがあります。
このオプションを省略した場合,デバッグログは出力されません。
このオプションに指定する値を次の表に示します。

表5-24 debugオプションに指定する値

ユーザーデータファイルの出力デバッグログの出力
0×
1×
2
上記以外の値×
指定しない×
(凡例)
○:出力する。
×:出力しない。
なお,ユーザーデータファイルは,インストール先フォルダ¥agtt¥agent¥jpcuser¥userdata配下のjpcuser_XXXを指します。XXXは,レコード形式のUPD,UPDB,UPI,またはUPIBに相当します。
デバッグログは,インストール先フォルダ¥agtt¥agent¥jpcuser¥debug配下のjpcuser_dbg_XX.logを指します。XXは,作成された順番を表します。デバッグログの出力例を次の表に示します。

表5-25 デバッグログの出力例

デバッグログファイル名説明
jpcuser_dbg_01.log最新のデバッグログファイル
jpcuser_dbg_02.log最新から1つ前のデバッグログファイル
jpcuser_dbg_03.log最新から2つ前のデバッグログファイル
・・・・・・
戻り値
0正常終了
1~100警告のある正常終了
101~255異常終了またはエラー発生