8.1.3 メッセージの説明
(1) メッセージテキストの形式
メッセージテキストは英文です。次の形式が基本となります。
メッセージ主文 (詳細情報名 = 詳細情報, 詳細情報名 = 詳細情報...)
【メッセージテキスト例】
The aaa server ended abnormally. (information 1 = aa....aa, information 2 = bb....bb, information 3 = cc....cc)
詳細情報は動的にテキストとして埋め込まれます。
(2) 詳細情報の出力要否
障害発生時には、値が取得可能な場合、次の情報を詳細情報として出力します。
-
ブランチXID(未採番の場合はルートXID)：分散トレースとの紐づけに使用します。Base64エンコードした値を出力します。
【メッセージテキスト例】
Test message. (branchxid = aa....aa)
aa....aa：ブランチXID
Test message. (rootxid = aa....aa)
aa....aa：ルートXID
次の情報は、メッセージログ出力処理で付与するため、詳細情報での出力は不要です。
-
出力日時
-
ログレベル
-
ホスト名
-
スレッド名
-
クラス名
-
プロセスID
(3) 例外の扱い
処理中に例外をthrowする場合、次のとおりメッセージを出力します。
-
新規に例外オブジェクトを作成（例：throw new Exception("KSFG10001-E test message.");）し、ユーザの対処が必要な例外詳細メッセージを付与する場合、KFSG64001-Eメッセージを出力します。
-
初回に異常系の例外をthrowする場合、java.lang.Throwable.printStackTrace()でスタックトレースを出力します。スタックトレース出力はメッセージ出力method内で実行します。
(4) 記載例KFSG10000の場合
メッセージの記載例を次に示します。
-
KFSG10000-E (Y)M
The aaa server ended abnormally. (information 1 = aa....aa, information 2 = bb....bb)
aaaサーバを異常終了します。
aa....aa：情報1
bb....bb：情報2
(Ｓ)aaaサーバを異常終了します。
(Ｏ)システム管理者に連絡してください。
- 〔対策〕
-
-
xxxメッセージログファイルにこのメッセージが出力された場合
aaaaaaaaコマンドを実行してトラブルシュート情報を取得してから、保守員に連絡してください。
-
yyyメッセージログファイルにこのメッセージが出力された場合
yyyのバックアップを取得してから、保守員に連絡してください。
-
(5) メッセージで出力するパラメタ名の形式
メッセージ中のパラメタ名はケバブケースで出力します。
パラメタがMediatorのパラメタの場合はキャメルケースに置き換えてパラメタの確認を行ってください。
例：(parameter = jp.co.Hitachi.soft.participant.sender.queue-size)
(parameter = jp.co.Hitachi.soft.participant.sender.queue-size)の場合、キャメルケースでのパラメタ名はパッケージ名"jp.co.Hitachi.soft"を除いた"participant.sender.queueSize"となります。