標準ログが出力するシステムログおよび性能ログのメッセージ本文について、説明します。
システムログは、アプリケーション連携実行基盤の稼働状態を表すインフォメーションログや、エラー情報を表すエラーログを表します。
システムログのメッセージ本文には、以下に示すフォーマットでメッセージが出力されます。
以下に、システムログのメッセージ本文の説明をします。
◆非同期アプリケーション連携実行基盤を利用する場合
No. | 項目名 | 出力内容 | 備考 |
---|---|---|---|
1 | ログ種別 | “IBS-AP-SYSTEM”という文字列が出力されます。 | - |
2 | 採取契機 | システムログが出力される契機です。 | - |
3 | メッセージID | メッセージIDが出力されます。 | - |
4 | アクティビティのキューDestination名 | アクティビティに関連付けられているキューのDestination名が出力されます。 | - |
5 | フロー定義名 | フロー定義名が出力されます。 | - |
6 | コリレーションID | コリレーションIDが出力されます。 | なお、本項目の出力内容には空白が含まれる場合があります。 |
7 | 業務処理実行アプリケーション名 | 以下のどちらかの形式で出力します。 【業務処理実行アプリケーションがCOBOLの場合】 業務処理名(業務処理関数名) (戻り値の型)関数名(パラメタ型...) 出力例: 【業務処理実行アプリケーションがJavaの場合】 クラス名 (戻り値の型)メソッド名(パラメタ型...) 出力例: | 業務処理実行アプリケーションを呼び出したときのみ出力されます。 【業務処理実行アプリケーションがC言語またはCOBOLの場合】 【業務処理実行アプリケーションがJavaの場合】 |
8 | アトリビュート | 業務処理実行アプリケーションの種別が通常のアプリケーションであった場合、以下の文字列が出力されます。 BusinessApplication 業務処理実行アプリケーションの種別が補償ルート制御処理を行うアプリケーションであった場合、以下の文字列が出力されます。 AmendsRouteApplication | 業務処理実行アプリケーションを呼び出したときのみ出力されます。 |
9 | アプリ種類 | 【C言語またはCOBOLアプリケーションの場合】 “C/COBOL Application”という文字列が出力されます。 【Javaアプリケーションの場合】 | 業務処理実行アプリケーションを呼び出したときのみ出力されます。 |
10 | 遷移種別 | メッセージの遷移情報を表す、以下のどれかの文字列が出力されます。 (注1) “NormalRoute” “PriorityChanged(条件式)” (注2) “PriorityNoChanged(条件式)” (注2) “AgencyRoute” “ConditionTransitionRoute(条件式)” (注2) “ConditionTransition(条件式)-PriorityChanged(条件式)” (注2) “ConditionTransition(条件式)-PriorityNoChanged(条件式)” (注2) “AmendsRoute” “EvacuateErrorQueueRoute” | メッセージを送信するときのみ出力されます。 なお、本項目の条件式の出力内容には空白が含まれます。 |
11 | 優先度 | メッセージの優先度情報を表す以下のいずれかの文字列が出力されます。 “ErrorMessage” “AmendsMessage” “High” “Normal” “Low” | - |
12 | 例外情報 | 発生したエラー情報により出力文字列は可変となります。 | エラーが発生した場合のみ出力されます。 なお、本項目の出力内容には空白や改行が含まれる場合があります。 |
13 | Destination名 | 以下のどれかの文字列が出力されます。 (注1) メッセージの送信先Destination名 メッセージを退避したエラーメッセージ退避キューのDestination名、または閉塞を行ったDestination名 処理結果キューからのメッセージ受信を行う際の受信先Destination名 | 左記の契機でのみ出力されます。 |
注1) 業務処理開始アプリケーションまたは処理結果キューからのメッセージ受信を行うユーザのアプリケーションにより出力される標準ログでは、キュー情報が確定するまでは、情報が出力されないことがあります。
注2) 条件式に“default”という文字列が出力された場合は、フロー定義で定義した条件式が、「条件不成立」であることを示します。
注意
各項目の出力内容のなかに空白が含まれることがあります。
◆同期アプリケーション連携実行基盤を利用する場合
No. | 項目名 | 出力内容 | 備考 |
---|---|---|---|
1 | ログ種別 | “IBS-AP-SYSTEM”という文字列が出力されます。 | - |
2 | 採取契機 | システムログが出力される契機です。 | - |
3 | メッセージID | メッセージIDが出力されます。 | - |
4 | 業務名 | Impl IDで指定されたIDを出力します。また、出力される文字列は、大括弧“[]”で括られます。 | - |
5 | アプリケーション名 | クライアントで指定されたサーバアプリケーション名を出力します。 | アプリケーションを呼び出したときに、アプリケーション名を出力します。上記以外の契機では、“*****”が出力されます。 |
6 | 情報 | 発生した例外情報、または、付加情報を出力します。 | - |
注意
本ログで出力するメッセージ本文の項目は、ログ定義ファイルを用いて変更することは出来ません。
■ログの出力契機
システムログは、以下の表に示す契機で出力されます。
◆非同期アプリケーション連携実行基盤を利用する場合
ログ出力契機 | メッセージID | ログの出力レベル | 採取契機の出力内容 |
---|---|---|---|
業務処理開始アプリケーションでsendMessageSyncメソッドを発行したとき、以下の規約で出力します。 | 8000 | 10 | API-sendMessageSync-Call |
8001 | 10 | API-sendMessageSync-Normal | |
8002 | 3 | API-sendMessgeSync-Error | |
業務処理開始アプリケーションでsendMessageメソッドを発行したとき、以下の規約で出力します。 “API-sendMessage-STATUS” | 8004 | 10 | API-sendMessage-Call |
8005 | 10 | API-sendMessage-Normal | |
8006 | 3 | API-sendMessage-Error | |
業務処理開始アプリケーションでreceiveMessageメソッドを発行したとき、以下の規約で出力します。
| 8008 | 10 | 出力例: |
8009 | 10 | 出力例: | |
8010 | 3 | 出力例: | |
フロー定義ルート終点 | 8012 | 10 | ENDINGPOINT-SendResultReceptionQueue-Call |
8013 | 10 | ENDINGPOINT-SendResultReceptionQueue-Normal | |
8014 | 3 | ENDINGPOINT-SendResultReceptionQueue-Error | |
8015 | 10 | ENDINGPOINT-SendResultReceptionQueue-Call(Retry-n) | |
フロー定義ルート終点 | 8016 | 10 | ENDINGPOINT-NoSendResultReceptionQueue-End |
業務処理実行アプリケーションを呼び出したとき、以下の規約で出力します。 | 8017 | 10 | Business-Application-Call |
8018 | 10 | Business-Application-Normal | |
8019 | 3 | Business-Application-Error | |
8020 | 10 | Business-Application-Call(Retry-n) | |
メッセージを送信したとき、以下の規約で出力します。 | 8021 | 10 | Message-sendMessageQueue-Call |
8022 | 10 | Message-sendMessageQueue-Normal | |
8023 | 3 | Message-sendMessageQueue-Error | |
8024 | 10 | Message-sendMessageQueue-Call(Retry-n) | |
アクティビティ単位でのアプリケーション連携実行基盤処理を開始したとき | 8025 | 10 | Apfw-Activity-Start |
アクティビティ単位でのアプリケーション連携実行基盤処理を終了したとき(ロールバックによる処理の戻りが発生したとき) | 8026 | 3 | Apfw-Activity-Rollbackend |
アクティビティ単位でのアプリケーション連携実行基盤処理を終了したとき(ロールバックによる処理の戻りが発生していないとき) | 8027 | 10 | Apfw-Activity-End |
エラーとなったメッセージをエラーメッセージ退避キューへ退避する事象が発生したとき | 8028 | 3 | Error-EvacuateMessage-ErrorQueue |
エラーとなったメッセージをシリアライズファイルに書き込む事象が発生したとき | 8029 | 3 | Error-EvacuateMessage-SeriarizeFile |
非同期ワークユニット停止事象が発生したとき | 8031 | 3 | Error-WorkUnit-Stop |
補償ルート制御事象が発生したとき | 8032 | 3 | Error-AmendsMessage-AmendsRoute |
異常処理出口を開始したとき | 8033 | 3 | Error-ErrorProcess-Start |
異常処理出口を終了したとき | 8034 | 3 | Error-ErrorProcess-End |
業務処理開始アプリケーションでsendMessageSyncメソッド/sendMessageメソッドを発行したとき | 8035 | 10 | Message-QueueType |
業務処理開始アプリケーションでreceiveMessageErrorメソッドを発行したとき、以下の規約で出力します。 “API-receiveMessageError()-STATUS” | 8036 | 10 | 出力例: |
8037 | 10 | 出力例: | |
8038 | 3 | 出力例: |
注) 業務処理開始アプリケーションがJavaの場合のみ出力します。
◆同期アプリケーション連携実行基盤を利用する場合
ログ出力契機 | メッセージID | ログの出力レベル | 採取契機の出力内容 |
---|---|---|---|
業務処理を呼び出したときに、以下の規約で出力します。 | 8201 | 10 | Business-Application-Call |
8202 | 10 | Business-Application-Normal(n) | |
8203 | 10 | Business-Application-Error(n) | |
8204 | 10 | Business-Application-Call(Retry-n) | |
振分け制御を呼び出したときに、以下の規約で出力します。 | 8211 | 10 | Set-Target-Call |
8212 | 10 | Set-Target-Normal | |
8213 | 10 | Set-Target-Error | |
業務前制御を呼び出したときに、以下の規約で出力します。 | 8214 | 10 | Pre-Business-Control-Call |
8215 | 10 | Pre-Business-Control-Normal | |
8216 | 10 | Pre-Business-Control-Error | |
業務後制御を呼び出したときに、以下の規約で出力します。 | 8217 | 10 | Post-Business-Control-Call |
8218 | 10 | Post-Business-Control-Normal(n) | |
8219 | 10 | Post-Business-Control-Error(n) | |
結果編集制御を呼び出したときに、以下の規約で出力します。 | 8220 | 10 | Result-Control-Call |
8221 | 10 | Result-Control-Normal(n) | |
8222 | 10 | Result-Control-Error(n) | |
初期処理を呼び出したときに、以下の規約で出力します。 | 8223 | 10 | Init-Call |
8224 | 10 | Init-Normal(n) | |
8225 | 10 | Init-Error(n) | |
終了処理を呼び出したときに、以下の規約で出力します。 | 8226 | 10 | Term-Call |
8227 | 10 | Term-Normal(n) | |
8228 | 10 | Term-Error(n) | |
その他のインフォメーションが発生したとき | 8205 | 10 | System-Info |
ワークユニット停止事象が発生したとき | 8031 | 3 | Error-WorkUnit-Stop |
業務処理を呼び出したときにシステムエラーが発生したとき | 8032 | 3 | Error-Request-Fail |
業務共通制御を呼び出したときにシステムエラーが発生したとき | 8231 | 3 | Error-Control-Fail |
apfw_get_target_nameを呼び出したとき | 8241 | 10 | Get-Target(name) (注2) |
apfw_get_target_nameを呼び出したとき | 8242 | 10 | Set-Target(name) (注2) |
注1) STATUSとある場合、以下の文字列が出力されます。
Call
処理の呼出しを表します。
Normal
処理の正常復帰を表します。
n - 処理結果情報の値(0 or 1)
Error
処理の異常復帰を表します。
n - 処理結果情報の値(0,1以外)
Call(Retry-n)
アプリケーション連携実行基盤のリトライによる処理やり直しの場合に出力されます。
n - リトライ回数
注2) nameにはターゲット名が出力されます。
■出力例
◆非同期アプリケーション連携実行基盤を利用する場合
以下に、「アクティビティ単位でのアプリケーション連携実行基盤処理を開始したとき」のシステムログの出力例を示します。
コンテキストIDを“ContextID”とします。
JMSDestination名を“Queue001”とします。
フロー定義名を“FlowA”とします。
コリレーションIDを“ID0001”とします。
優先度を“Normal”とします。
2004/11/05 19:07:11.000 [ContextID] IBS-AP-SYSTEM Apfw-Activity-Start 8025 [Queue001] FlowA ID0001 ***** ***** ***** ***** Normal ***** ***** |
◆同期アプリケーション連携実行基盤を利用する場合
以下に、「アプリケーション連携実行基盤から業務処理を呼び出す」のシステムログの出力例を示します。
採取契機は業務処理を呼び出すときです。
インプリメンテーションリポジトリIDを“imple01”とします。
アプリケーション名を“function01”とします。
情報を“xxxxxxxxxxxx”とします。
2005/11/05 19:07:11.377 [ContextID] IBS-AP-SYSTEM Business-Application-Call 8201 [imple01] function01 xxxxxxxxxxxx |
性能ログは、アプリケーション連携実行基盤内部での実行時間を表します。
性能ログのメッセージ本文には、以下に示すフォーマットでメッセージを出力します。
アプリケーション連携実行基盤では以下の情報を出力します。
◆非同期アプリケーション連携実行基盤を利用する場合
No. | 項目名 | 出力内容 |
---|---|---|
1 | ログ種別 | “IBS-AP-PERFORMANCE”という文字列が出力されます。 |
2 | 採取契機 | 性能ログが出力される契機です。 |
3 | メッセージID | “3.5.1.1 システムログ”の説明を参照してください。 |
4 | アクティビティのキューDestination名 | |
5 | フロー定義名 | |
6 | 業務処理実行アプリケーション名 | |
7 | メッセージ | 性能情報が出力されます。 出力例: |
注意
各項目の出力内容のなかに空白が含まれることがあります。
◆同期アプリケーション連携実行基盤を利用する場合
No. | 項目名 | 出力内容 |
---|---|---|
1 | ログ種別 | “IBS-AP-PERFORMANCE”という文字列が出力されます。 |
2 | 採取契機 | 性能ログが出力される契機です。 |
3 | メッセージID | メッセージIDが出力されます。 |
4 | 業務名 | Impl IDで指定されたIDを出力します。また、出力される文字列は、大括弧“[]”で括られます。 |
5 | アプリケーション名 | クライアントで指定されたアプリケーション名を出力します。 |
6 | メッセージ | 性能情報が出力されます。 |
■セション情報
アプリケーション連携実行基盤で出力されるセション情報は以下の2つがあります。
No. | 項目名 | 定義名 | 長さ | 出力内容 |
---|---|---|---|---|
1 | ホスト名 | session.hostName | 16 | ホスト名が出力されます。 |
2 | サブシステム名 | session.subSystemID | 7 | サブシステム名が指定されたときだけ、ユーザ任意の値が出力されます。(注2) |
注1) 出力する情報が“長さ”に満たない場合、その分は空白が出力されます。ホスト名が“HOST”、サブシステム名が“SUB”、通信データサイズが26byte、要素が2つある場合の例を、以下に示します。
HOST SUB 26 要素A=(aa)要素B=(bb) |
注2) 初期化パラメタについては、“3.4 サブシステム名”を参照してください。以下に例を示します。
■ログの出力契機
◆非同期アプリケーション連携実行基盤を利用する場合
性能ログは、以下の位置で出力されます。
フローの起動、および処理結果キューからのメッセージを受信したとき
【業務処理開始アプリケーションの場合】
sendMessageSync・sendMessageメソッドを発行したときから、sendMessageSync・receiveMessageメソッドに復帰するまで、または結果受信キューにメッセージを格納するまで、またはフロー定義の終点まで
以下の図に、出力位置について例に示します。
1アクティビティ処理時間
1アクティビティのアプリケーション連携実行基盤処理の開始から終了まで
メッセージを送信したとき
次の宛先へメッセージ送信処理を行う時間
業務処理実行アプリケーション
【業務処理実行アプリケーションがCOBOLの場合】
業務処理実行アプリケーションを構成する全関数(前処理、業務処理、後処理、エラー処理)の最初の関数を呼び出す直前から最後の関数より復帰するまで
業務処理実行アプリケーションの前処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションの業務処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションの後処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションのエラー処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションの初期処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションの終了処理を呼び出す直前から復帰するまで
【業務処理実行アプリケーションがJavaの場合】
業務処理実行アプリケーションのクラスを構成する全メソッド(コンストラクタ、前処理、業務処理、後処理、エラー処理)の最初のメソッドを呼び出す直前から最後のメソッドより復帰するまで
業務処理実行アプリケーションの前処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションの業務処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションの後処理を呼び出す直前から復帰するまで
業務処理実行アプリケーションのエラー処理を呼び出す直前から復帰するまで
以下の図に、出力位置について業務処理実行アプリケーションがJavaの場合の例を示します。
ログ出力契機 | メッセージID | ログの出力レベル | 採取契機の出力内容 |
---|---|---|---|
【業務処理開始アプリケーションの場合】 | 8150 | 3 | StartOfBusiness-Return |
【業務処理開始アプリケーションの場合】 | 8151 | 3 | StartOfBusiness-ToResultReceptionQueue |
【業務処理開始アプリケーションの場合】 | 8152 | 3 | StartOfBusiness-ToEndingPoint |
アプリケーション連携実行基盤の処理が開始され、終了したとき | 8153 | 10 | Apfw-Activity |
メッセージ送信処理を開始し、終了したとき | 8154 | 15 | Message-sendMessage |
【業務処理実行アプリケーションがCOBOLの場合】 業務処理実行アプリケーションを構成する全関数(前処理、業務処理、後処理、エラー処理)の最初の関数を呼び出した後、最後の関数より復帰したとき 【業務処理実行アプリケーションがJavaの場合】 | 8155 | 15 | Business-Application-Class |
業務処理実行アプリケーションの前処理を呼び出した後、復帰したとき 業務処理実行アプリケーションの業務処理を呼び出した後、復帰したとき 業務処理実行アプリケーションの後処理を呼び出した後、復帰したとき 業務処理実行アプリケーションのエラー処理を呼び出した後、復帰したとき 以下は業務処理実行アプリケーションがCOBOLの場合のみ出力されます。 業務処理実行アプリケーションの初期処理を呼び出した後、復帰したとき 業務処理実行アプリケーションの終了処理を呼び出した後、復帰したとき | 8156 | 15 | Business-Application-Method |
注) 8151, 8152 はいずれか一方が出力されます。
◆同期アプリケーション連携実行基盤を利用する場合
ログ出力契機 | メッセージID | ログの出力レベル | 採取契機の出力内容 |
---|---|---|---|
アプリケーションからアプリケーション連携実行基盤へ処理を返却したとき | 8451 | 3 | Target-Application |
前処理からアプリケーション連携実行基盤へ処理を返却したとき | 8452 | 10 | Pre-Business-Application |
業務処理からアプリケーション連携実行基盤へ処理を返却したとき | 8453 | 10 | Business-Application |
後処理からアプリケーション連携実行基盤へ処理を返却したとき | 8454 | 10 | Post-Business-Application |
振分け制御からアプリケーション連携実行基盤へ処理を返却したとき | 8461 | 10 | Set-Target-Control |
業務前制御からアプリケーション連携実行基盤へ処理を返却したとき | 8462 | 10 | Pre-Business-Control |
業務後制御からアプリケーション連携実行基盤へ処理を返却したとき | 8463 | 10 | Post-Business-Control |
結果編集制御からアプリケーション連携実行基盤へ処理を返却したとき | 8464 | 10 | Result-Control |
アプリケーション連携実行基盤からクライアントへレスポンスを返却したとき | 8471 | 3 | Request-Response |
■出力例
◆非同期アプリケーション連携実行基盤を利用する場合
以下に、「アプリケーション連携実行基盤の処理開始から終了まで」の性能ログの出力例を示します。
コンテキストIDを“ContextID”とします。
アクティビティに関連付けされているJMSDestination名を“Queue001”とします。
フロー定義名を“FlowA”とします。
ホスト名を“hostname”とします。
サブシステム名の指定がなしとします。
“開始時刻”は、2004年11月05日19時07分07秒(484ミリ秒)とします。
“出力時刻”は、2004年11月05日19時07分11秒(377ミリ秒)とします。
2004/11/05 19:07:11.377 [ContextID] IBS-AP-PERFORMANCE Apfw-Activity 8153 [Queue001] FlowA ***** hostname 2004/11/05 19:07:07:484 2004/11/05 19:07:11:377 3893 |
◆同期アプリケーション連携実行基盤を利用する場合
以下に、「アプリケーション連携実行基盤から業務処理を呼び出す」性能ログの出力例を示します。
採取契機は業務処理の呼び出すときです。
インプリメンテーションリポジトリIDは“imple01”とします。
アプリケーション名は“function01”とします。
開始時刻は“2005年11月05日19時07分07秒”です。
終了時刻は“2005年11月05日19時07分11秒”です。
2005/11/05 19:07:11.377 [ContextID] IBS-AP-PERFORMANCE Target-Application 8451 [imple01] function01 2004/11/05 19:07:07:484 2004/11/05 19:07:11:377 3893 |