6.8.4 ユーザー作成データのファイル形式
ユーザー作成データのファイル形式について説明します。パフォーマンスデータを収集するユーザーコマンドでは,この形式に従ってテキスト出力するようにしてください。
ユーザー作成データのファイルに出力する情報として,プロダクト情報セクションとデータセクションがあります。プロダクト情報セクションとデータセクションは,ユーザー作成データのファイルごとに作成してください。ユーザー作成データの構成例を次の図に示します。
|
- 〈この項の構成〉
(1) プロダクト情報セクション
製品名と,ユーザー作成データのファイル形式のバージョンを設定するセクションです。これらは固定値です。プロダクト情報セクションは内部機能で使用され,ユーザーレコードには格納されません。
形式を次に示します。
Product Name=PFM-Agent for Platform (Windows) FormVer=0001
- 注意
-
上記の指定方法について,「=」の前後などにスペースが含まれる場合はエラーとなります。また,指定する文字の大文字小文字および全角半角も区別されます。
(2) データセクション
パフォーマンスデータの情報を設定するセクションです。この情報は,プロダクト情報セクションの下に指定します。データセクションは,オプションヘッダー部とデータ部で構成されます。
(a) オプションヘッダー部
1行目はオプションヘッダー行です。フィールドオプションを1バイト以上のスペースまたはタブで区切ります。フィールドオプションは,ユーザーレコードのフィールドに対応します。
tt ks ki l ・・・
オプションと,対応するレコードのフィールド名を次の表に示します。「フィールド数」列のフィールド数を上限にそのオプションを複数指定できます。例えば,PI_UPIレコードでフィールドオプションに「ss」を複数指定する場合,項番10の「PI_UPI」列に「4」と表記されているので,PI_UPIレコードでは「ss ss ss ss」のように4個まで「ss」を指定できます。
項番 |
オプション名 |
フィールド名 |
値の説明 |
フィールド数(合計) |
||||
---|---|---|---|---|---|---|---|---|
PD_UPD(17) |
PD_UPDB(34) |
PI_UPI(23) |
PI_UPIB(49) |
PI_XUI1〜PI_XUI5(67) |
||||
1 |
tt |
Trans Type |
トランザクションタイプ。このオプションは必ず指定する。※1 サイズ:1〜19バイト |
1 |
1 |
1 |
1 |
1 |
2 |
ki |
Trans Data Key |
数値型のトランザクションキー。kiまたはksのどちらかを必ず指定する。両方指定することもできる。 タイプ:ulong 指定できる文字:数値および記号(+) |
1 |
1 |
1 |
1 |
1 |
3 |
ks |
Trans String Key |
文字列型のトランザクションキー。kiまたはksのどちらかを必ず指定する。両方指定することもできる。※1 サイズ:1〜19バイト |
1 |
1 |
1 |
1 |
1 |
4 |
f |
User Float |
浮動小数点数※2 タイプ:double |
2 |
5 |
2 |
5 |
30 |
5 |
fr※3 |
User Float Roll |
累積値の浮動小数点数※2 タイプ:double |
− |
− |
2 |
5 |
30 |
6 |
l |
User Long |
符号つきlong タイプ:long 指定できる文字:数値および記号(- +) |
2 |
5 |
2 |
5 |
− |
7 |
lr※3 |
User Long Roll |
累積値の符号つきlong タイプ:long 指定できる文字:数値および記号(- +) |
− |
− |
2 |
5 |
− |
8 |
sl |
User String(64) |
64バイトの文字列※1 サイズ:1〜63バイト + NULL |
1 |
5 |
1 |
5 |
2 |
9 |
sm |
User String(32) |
32バイトの文字列※1 サイズ:1〜31バイト + NULL |
2 |
5 |
2 |
5 |
− |
10 |
ss |
User String(16) |
16バイトの文字列※1 サイズ:1〜15バイト + NULL |
4 |
5 |
4 |
5 |
− |
11 |
sv |
User String(128) |
128バイトの文字列※1 サイズ:1〜127バイト + NULL |
− |
− |
− |
− |
1 |
12 |
t |
User Time |
時刻(time_t型) 次の形式で指定する。 YYYY/MM/DD,hh:mm:ss jpcuserコマンドを実行するマシンのLocalTimeを設定する。 |
1 |
1 |
1 |
1 |
1 |
13 |
u |
User Unsigned Long |
符号なしlong タイプ:ulong 指定できる文字:数値および記号(+) |
2 |
5 |
2 |
5 |
− |
14 |
ur※3 |
User Unsigned Long Roll |
累積値の符号なしlong タイプ:ulong 指定できる文字:数値および記号(+) |
− |
− |
2 |
5 |
− |
- (凡例)
-
−:指定できない。
- 注※1
-
指定できる文字は,英文字(大文字,小文字),数値,空白,および記号(` ~ ! @ # $ % ^ & * ( ) _ + - = { } : ; < > , . ? / | \ [ ])です。
- 注※2
-
指定できる文字は,数値,および記号(- + .)です。
- 注※3
-
fr,lr,urを履歴収集したデータで集約して表示した場合は,累積値が表示されます。これらのオプションとki以外の数値オプションは平均値が表示されます。
なお,ユーザー作成データに複数のフィールドオプションを指定した場合は,ユーザーレコードの対象フィールドの連番順に割り当てられます。
例えば,PI_UPIBレコードでフィールドオプションに「lr」を3個指定する場合は,「lr lr lr」と指定します。この場合,「lr」はそれぞれ次のフィールドに割り当てられます。
-
1個目のlr:User Long Roll 1
-
2個目のlr:User Long Roll 2
-
3個目のlr:User Long Roll 3
また,「sl lr sl lr lr」のように指定した場合は,それぞれ次のフィールドに割り当てられます。
-
1個目のsl:User String 11
-
2個目のlr:User Long Roll 1
-
3個目のsl:User String 12
-
4個目のlr:User Long Roll 2
-
5個目のlr:User Long Roll 3
(b) データ部
2行目以降はデータ行です。データ行には,オプションヘッダー部に指定したフィールドオプションに対応するように,パフォーマンスデータそのものを指定します。各カラムは,1バイト以上のスペースまたはタブで区切ります。
データの並び順は,必ずフィールドオプションの型に合わせてください。
例えば,フィールドオプションに「tt ks lr lr ss ss」と指定した場合,次のデータの並び順では,すべての行がエラーとなります。
TCP jp1host "ESTABLISHD COUNT=" 5 "LISTENING COUNT=" 2 TCP jp1host "ESTABLISHD COUNT=" 3 "LISTENING COUNT=" 1 TCP jp1host "ESTABLISHD COUNT=" 3 "LISTENING COUNT=" 2
3列目と6列目のフィールドオプションとデータの型が一致していないことがエラーの原因です。
-
3列目
フィールドオプション「lr」に合わせて「蓄積したlong型整数値」が指定されるべきところに,文字列「"ESTABLISHD COUNT="」が指定されています。
-
6列目
フィールドオプション「ss」に合わせて「サイズ16の文字列」が指定されるべきところに,整数値「2,1,2」が指定されています。
(3) 注意事項
-
ユーザー作成データファイルは,アスキーファイルで作成してください。
-
このファイルの各データラインは,キャリッジリターンキャラクタ+ラインフィードキャラクタ(CR+LF)によって終了する必要があります。
-
ユーザー作成データファイルにコメントは記述できません。
-
ユーザー作成データファイルの1行目から3行目に,空行または半角スペース行が含まれる場合はエラーとなります。
-
ユーザー作成データファイルの4行目以降に,空行または半角スペース行が含まれる場合は,空行または半角スペース行は無視されます。
-
スペースを含む文字列が入力される場合は,設定する文字列を" "で囲みます。
-
stringタイプでは,印字できる英数字のシングルバイトの文字列値を設定してください。"のような特別なシングルバイトキャラクターは設定できません。
-
オプションヘッダー行に指定できるフィールドオプションの定義は,1つのユーザー作成データファイルごとに1つです。異なるフィールドオプションを定義したい場合,別のユーザー作成データファイルを作成してください。
-
ユーザー作成データファイルの先頭にBOM※が付加されないように作成してください。ユーザー作成データファイルの先頭にBOMが付加されていると,jpcuserコマンドの実行時にエラーとなります。
- 注※
-
Byte Order Markの略。Unicodeのファイル(UTF-16 Little Endian,UTF-16 Big Endian,UTF-8など)の種類を判定するためにファイルの先頭に付加した識別子です。
UTF-16の場合は2バイト,UTF-8の場合は3バイトの識別子が付加されます。