2.1 ログ出力フォーマット

ログ出力フォーマット

ログ定義ファイルで任意の項目を指定することにより、ログ出力フォーマットを指定することができます。ログ出力で出力するフォーマットを示します。

参照

No.列について

出力パターン列について

msgFormatタグで指定されたフォーマットのパターンによって出力される項目を示します。

ログは項目の並び順で出力されます。

長さが定められている項目を出力する場合に、長さに満たない場合は、左詰めとし残りを空白で埋めます。また、長さを超える場合には、超過文字を切り捨てて出力を行います。

基本フォーマット

基本フォーマットを定義名により定義できます。定義名には次のものがあります。

出力パターンに△があるものは、com.fujitsu.uji.log.LogComposerおよびcom.fujitsu.uji.log.ext.ExtMessageComposerでのみ出力する項目です。
出力パターンに□があるものは、com.fujitsu.uji.log.LogComposerおよびcom.fujitsu.uji.log.ext.ExtLogComposer派生クラスでのみ出力する項目です。

No.	定義名	項目名	長さ	出力パターン			出力内容
No.	定義名	項目名	長さ	1	2	3	出力内容
1	%d	時刻	不定		△	○	出力が要求された日時
2	%t	スレッド名	不定			○	出力を要求したスレッド名
3	%s	メソッド	不定				出力を要求したメソッド名
4 ○△	%l	ログレベル	不定				出力で指定されたレベル
5	%%	%記号	1				%記号を表示
6	%i	コンテキストID	不定	□	□	□	ログ出力時のコンテキストID
7 ○△	%m	メッセージ本文	不定	○	○	○	メッセージ本文以下のログ出力メソッドを使用する場合は指定のメッセージ本文のフォーマットで出力 com.fujitsu.uji.log.ext.ExtMessageComposerクラスのprintMessageメソッド com.fujitsu.uji.log.ext.ExtDataComposerクラスのprintDataメソッド com.fujitsu.uji.log.ext.ExtTimeComposerクラスのprintTimeメソッド

コンテキストIDは、以下のように括弧をつけて出力を行います。コンテキストIDが空文字列またはnullの場合、括弧は出力されません。

[コンテキストID]

フォーマットの指定が無い場合には、以下の項目を空白文字で区切って出力します。ただし、コンテキストIDとメッセージ本文の間は、空白文字で区切られません。

com.fujitsu.uji.log.ext.ExtDataComposer、com.fujitsu.uji.log.ext.ExtTimeComposerおよびこれらの派生クラス
```
コンテキストIDメッセージ本文
```

その他

時刻 コンテキストIDメッセージ本文

メッセージ本文のフォーマット

メッセージ本文のフォーマットを定義名により定義できます。定義名には次のものがあります。

出力パターンに△があるものは、com.fujitsu.uji.log.ext.ExtMessageComposerおよびこの派生クラスで、デフォルトで出力する項目です。

No.	定義名	項目名		長さ	出力パターン			出力内容
No.	定義名	項目名		長さ	1	2	3	出力内容
1 ○△	label	ラベル（ソース名）			○	○	○	管理コード、識別名、識別名サブを出力。長さの設定は無効
	label.code	1	管理コード	3				英数字、任意
	label.name	2	識別名	12				英数字、任意の識別名。業務名など
	label.subname	3	識別名サブ	9				英数字、任意の識別名。モジュール名など
2 △	errorType	エラー種別		7	△	△	○	エラー種別 HALT：停止 ERROR：エラー WARNING：警告 INFO：情報
3 ○△	messageID	メッセージID		5	○	○	○	英数字
4 ○△	message	メッセージ			○	○	○	指定のメッセージのフォーマットで出力。長さの設定は無効

フォーマットの指定が無い場合には、以下の項目を空白文字で区切って出力します。

com.fujitsu.uji.log.ext.ExtMessageComposerおよびこの派生クラス
```
ラベル エラー種別 メッセージID メッセージ
```
com.fujitsu.uji.log.ext.ExtDataComposer、com.fujitsu.uji.log.ext.ExtTimeComposerおよびこれらの派生クラス
```
ラベル メッセージID メッセージ
```

メッセージのフォーマット

使用するクラスにより出力内容が異なります。

com.fujitsu.uji.log.ext.ExtMessageComposerおよびこの派生クラス

メッセージ本文のフォーマットを定義名により定義できます。定義名には次のものがあります。

No.	定義名	項目名	長さ	出力パターン			出力内容
No.	定義名	項目名	長さ	1	2	3	出力内容
1	message.session	セション情報				○	指定されたセション情報。長さの設定は無効
2 △	message.body	メッセージ本体	不定推奨1,024以内	○	○	○	メッセージ本体。置き換え指定は出現順にそれぞれ"{0}"、"{1}"、"{2}"、"{3}"、...と記述

フォーマットの指定が無い場合には、以下の項目を空白文字で区切って出力します。

メッセージ本体

com.fujitsu.uji.log.ext.ExtDataComposerおよびこの派生クラス

メッセージ本文のフォーマットを定義名により定義できます。定義名には次のものがあります。

No.	定義名	項目名	長さ	出力パターン			出力内容
No.	定義名	項目名	長さ	1	2	3	出力内容
1	message.session	セション情報		○	○	○	指定されたセション情報。長さの設定は無効
2	message.bodyLength	データ長	5	○	○	○	データ本体の長さ
3 ○	message.body	データ本体	不定 51,200以内を推奨	○	○	○	プロパティ名=(値)の形式

フォーマットの指定が無い場合には、以下の項目を空白文字で区切って出力します。

セション情報 データ長 データ本体

com.fujitsu.uji.log.ext.ExtTimeComposerおよびこの派生クラス

メッセージ本文のフォーマットを定義名により定義できます。定義名には次のものがあります。

No.	定義名	項目名	長さ (バイト)	出力パターン			出力内容
No.	定義名	項目名	長さ (バイト)	1	2	3	出力内容
1	message.session	セション情報		○	○	○	指定されたセション情報。長さの指定は無効
2	message.start	開始時刻	不定	○	○	○	時間計測開始時点の時刻時刻の表示フォーマットはjava.text.SimpleDateFormatで指定可能な形式で指定
3	message.current	出力時刻	不定	○	○	○	ログ出力時の時刻時刻の表示フォーマットはjava.text.SimpleDateFormatで指定可能な形式で指定
4	message.passage	経過時間	不定	○	○	○	出力時刻から開始時刻の差をミリ秒単位で出力

フォーマットの指定が無い場合には、以下の項目を空白文字で区切って出力します。

セション情報 開始時刻 出力時刻 経過時間

セション情報のフォーマット

セション情報のフォーマットを定義名により定義できます。定義名には次のものがあります。

出力パターンに△があるものは、通信ログのデフォルトです。

No.	定義名	項目名	長さ	出力パターン
No.	定義名	項目名	長さ	1	2	3
1	session.hostName	ホスト名	16	○	○	○
2	session.subSystemID	サブシステム名	7	○	○	○
3	session.requestDate	処理日	17	△	△	○

フォーマットの指定が無い場合には、以下の項目を出力します。

com.fujitsu.uji.log.ext.ExtDataComposerおよびこの派生クラス
区切り文字なしで出力します。処理日はyyyyMMddHHmmssSSSの形式で出力します。
```
ホスト名サブシステム名処理日
```

com.fujitsu.uji.log.ext.ExtTimeComposerおよびこの派生クラス
空白を区切り文字として出力します。
```
ホスト名 サブシステム名
```