7.3.2 障害情報の取得方法(サービスプラットフォーム)
サービスプラットフォームが出力するメッセージログ,トレース,および各種情報の取得方法について説明します。また,事前に必要な設定についても説明します。出力された障害情報の確認方法については,「7.4 出力された障害情報の確認方法」を参照してください。
- 〈この項の構成〉
(1) メッセージログの取得方法
メッセージログは必ず出力されます。なお,メッセージログを出力するファイルのサイズや面数は,必要に応じて変更できます。
出力されたメッセージログの確認方法については,「7.4.1 メッセージログ」を参照してください。
(a) HCSC-Managerのログ
HCSC-Manager定義ファイルで次のパラメタを指定します。
-
cscmng.log.message.filesize=メッセージログファイルサイズ
-
cscmng.log.message.filenum=メッセージログファイル面数
HCSC-Manager定義ファイルの詳細については,マニュアル「サービスプラットフォーム リファレンス」の「6.5.3 HCSC-Manager定義ファイル」を参照してください。
(b) 統合メッセージログ
統合メッセージログは,manager.cfg(Managerログ設定ファイル)でファイルのサイズ,面数などを指定します。manager.cfgの詳細については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「8.2.9 manager.cfg(Manager設定ファイル)」を参照してください。
(c) J2EEサーバの稼働ログ
J2EEサーバの稼働ログは次のように指定します。
-
ファイルの出力先
HCSCサーバが動作するJ2EEサーバのusrconf.cfg(J2EEサーバ用オプション定義ファイル)のejb.server.log.directoryキーで指定します。デフォルトの出力先は次のとおりです。
<サービスプラットフォームのインストールディレクトリ>\CC\server\public\ejb\<J2EEサーバ名>\logs
usrconf.cfgの詳細については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「2.2.2 usrconf.cfg(J2EEサーバ用オプション定義ファイル)」を参照してください。
-
ファイルのサイズ,面数など
HCSCサーバが動作するJ2EEサーバのusrconf.properties(J2EEサーバ用ユーザプロパティファイル)で指定します。
usrconf.propertiesの詳細については,次に示すマニュアルを参照してください。
-
推奨モードの場合
マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「2.2.3 usrconf.properties(J2EEサーバ用ユーザプロパティファイル)」
-
V9互換モードの場合
マニュアル「アプリケーションサーバ 機能解説 互換編」の「10.1.1 usrconf.properties(J2EEサーバ用ユーザプロパティファイル)」
-
(2) リクエストトレースの取得方法
リクエストトレースを取得する際には,HCSCサーバランタイム定義ファイルの次のプロパティで採取の有無を指定します。
また,出力先パスやファイルのサイズ,およびファイル面数を変更できます。
-
requesttrace=リクエストトレースの採取の有無(ONを指定します)
-
requesttrace-filepath=リクエストトレースの出力先パス
-
requesttrace-filesize=リクエストトレースファイルサイズ
-
requesttrace-filenum=リクエストトレース面数
出力されたリクエストトレースの確認方法については,「7.4.2 リクエストトレース」を参照してください。また,トレースファイルのローテーション方式などの設定については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」を参照してください。
(3) 性能解析トレースの取得方法
性能解析トレースファイルの取得方法および出力先は,アプリケーションサーバおよびサービスプラットフォーム全体で共通です。出力された性能解析トレースの確認方法については,「7.4.3 性能解析トレース」を参照してください。また,性能解析トレースファイルの取得方法および出力先については,マニュアル「アプリケーションサーバ 機能解説 保守/移行編」の「7.3 Management Serverを利用した性能解析トレースファイルの収集」を参照してください。
(4) ユーザ電文トレースの取得方法
ユーザ電文トレースを取得する際には,HCSCサーバランタイム定義ファイルの次のプロパティで採取の有無を指定します。また,出力先パス,ファイルのサイズ,ファイル面数なども変更できます。
-
telegramtrace=ユーザ電文トレースの採取の有無(ONを指定します)
-
telegramtrace-filepath=ユーザ電文トレース出力先パス
-
telegramtrace-filesize=ユーザ電文トレースファイルサイズ
-
telegramtrace-filenum=ユーザ電文トレース面数
-
telegramtrace-trigger=ユーザ電文トレースの出力契機
-
telegramtrace-format=ユーザ電文トレースの出力形式
さらに,次のプロパティで,正常処理時にユーザ電文トレースを出力するHCSCコンポーネントを指定できます。
-
telegramtrace-component-type-filepath=ユーザ電文トレースのコンポーネント種別設定ファイルのパス
-
telegramtrace-component-id-filepath=ユーザ電文トレースのコンポーネントID設定ファイルのパス
出力されたユーザ電文トレースの確認方法については,「7.4.4 ユーザ電文トレース」を参照してください。また,トレースファイルのローテーション方式などの設定については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」を参照してください。
(5) アクティビティトレースの取得方法
開発環境でアクティビティトレースを出力する場合は,HCSCサーバランタイム定義ファイルの次のプロパティにONを指定します。
-
bpacttrace=アクティビティトレースの採取の有無(ONを指定します)
また,次のプロパティで,ファイル面数およびファイルサイズの変更や,出力項目の追加を設定できます。
-
bpacttrace-filenum=ビジネスプロセスのアクティビティトレース面数
-
bpacttrace-filesize=ビジネスプロセスのアクティビティトレースファイルサイズ
-
bpacttrace-extend-item={NONE|PROCESSINSTANCEID}
出力されたアクティビティトレースの確認方法については,「7.4.5 アクティビティトレース」を参照してください。
(6) デバッグ情報の取得方法
次の機能では,ユーザ電文トレースにデバッグ情報を取得できます。
-
データ変換API
-
HCSCサーバで動作するデータ変換
-
csctransformコマンド
-
cscbinaryparseコマンド
デバッグ情報の取得方法は,機能ごとに次のように異なります。
(a) データ変換APIの実行時に出力されるデバッグ情報
データ変換APIの実行時に出力されるデバッグ情報を取得するには,usrconf.properties(J2EEサーバ用ユーザプロパティファイル)の次に示すシステムプロパティを設定してください。これらのシステムプロパティの設定方法については,「2.3.9(8) データ変換APIの動作を指定する」を参照してください。
-
csc.dt.debugtrace=デバッグ情報の出力有無(ONを指定します)
-
csc.dt.debugtrace.filepath=デバッグ情報の出力先パス
-
csc.dt.debugtrace.filenum=デバッグ情報ファイルの最大面数
-
csc.dt.debugtrace.filesize=デバッグ情報ファイルの1面当たりの最大サイズ
これによって,csc.dt.debugtrace.filepathプロパティで設定したパスにデバッグ情報が出力されます。ファイルは次のように,データ変換APIのインスタンス(グループ)ごとに異なるファイル名で出力されます。シフトモードの場合はファイル名に<面数>は入りません。
cscdebug_<グループ名>_<面数>.log
それ以外のファイルのローテーション方式や切り替え時刻などの設定方法については,次に示すマニュアルを参照してください。
-
推奨モードの場合
マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「2.2.3 usrconf.properties(J2EEサーバ用ユーザプロパティファイル)」,
-
V9互換モードの場合
マニュアル「アプリケーションサーバ 機能解説 互換編」の「10.1.1 usrconf.properties(J2EEサーバ用ユーザプロパティファイル)」
(b) HCSCサーバでのデータ変換時に出力されるデバッグ情報
HCSCサーバでのデータ変換時に出力されるデバッグ情報を取得するには,HCSCサーバランタイム定義ファイルの次のプロパティで,採取の有無を指定します。
-
telegramtrace=ユーザ電文トレースの採取の有無(デバッグ情報の採取もONを指定します)
また,次のプロパティで,出力先パス,ファイルのサイズ,ファイル面数および出力契機を指定します。
-
telegramtrace-filepath=ユーザ電文トレース出力先パス
-
telegramtrace-filesize=ユーザ電文トレースファイルサイズ
-
telegramtrace-filenum=ユーザ電文トレース面数
-
telegramtrace-trigger=ユーザ電文トレースの出力契機(デバッグ情報の出力を示すDTERRを指定します)
telegramtrace-triggerプロパティには複数の値をコンマで区切って指定できるため,ユーザ電文トレースの出力契機と,デバッグ情報の出力契機を同時に指定できます。
デバッグ情報のファイル名を次に示します。シフトモードの場合はファイル名に<面数>は入りません。
csctelegram_<HCSCサーバ名>_<面数>.log
出力されたデバッグ情報の確認方法については,「7.4.6 デバッグ情報」を参照してください。また,トレースファイルのローテーション方式などの設定については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」を参照してください。
(c) データ変換単体テストコマンドの実行時に出力されるデバッグ情報
データ変換単体テストコマンド(csctransformコマンド,cscbinaryparseコマンド,およびcscgenbinaryコマンド)の実行時に出力されるデバッグ情報を取得するには,各コマンドの実行時(またはコマンドプロパティファイル)で指定します。詳細については次に示す記載個所を参照してください。
項目 |
記載個所 |
---|---|
csctransformコマンド |
マニュアル「サービスプラットフォーム リファレンス」の「csctransform(データ変換のテスト)」 |
データ変換コマンドプロパティファイル(csctransformコマンドのコマンドプロパティファイル) |
マニュアル「サービスプラットフォーム リファレンス」の「3.14.1 データ変換コマンドプロパティファイル」 |
cscbinaryparseコマンド |
マニュアル「サービスプラットフォーム リファレンス」の「cscbinaryparse(DOMとバイナリデータの相互変換)」 |
バイナリパースコマンドプロパティファイル(cscbinaryparseコマンドのコマンドプロパティファイル) |
マニュアル「サービスプラットフォーム リファレンス」の「3.14.5 バイナリパースコマンドプロパティファイル」 |
cscgenbinaryコマンド |
マニュアル「サービスプラットフォーム リファレンス」の「cscgenbinary(バイナリフォーマット定義ファイルからバイナリ電文の生成)」 |
バイナリ電文生成コマンドプロパティファイル(cscgenbinaryコマンドのコマンドプロパティファイル) |
マニュアル「サービスプラットフォーム リファレンス」の「3.14.3 バイナリ電文生成コマンドプロパティファイル」 |
デバッグ情報のファイル名を次に示します。
cscdebug_dtcommand_<面数>.log
出力ファイルの最大面数は16,1面当たりの最大サイズは2147483647バイトです。面数の最大値,最大サイズ,ローテーション方式は変更できません。
(7) 定義情報の取得方法
障害の調査に,サービスプラットフォームに設定した定義が必要になる場合があります。定義の詳細については,マニュアル「サービスプラットフォーム リファレンス」の「6. 定義ファイル(運用環境・実行環境)」を参照してください。
(8) 保守情報の取得方法
システム管理者または保守員に連絡するときに必要な保守情報の取得方法を説明します。出力された保守用ログおよびトレースの確認方法については,「7.4.7 保守用ログおよびトレース」を参照してください。
(b) メンテナンスログ
メンテナンスログは必ず出力されます。メンテナンスログは,出力されるファイルのサイズ,および面数を変更できます。
HCSC-Manager定義ファイルの次のパラメタを指定します。
-
cscmng.log.maintenance.filesize=メンテナンスログファイルサイズ
-
cscmng.log.maintenance.filenum=メンテナンスログファイル面数
HCSC-Manager定義ファイルの詳細については,マニュアル「サービスプラットフォーム リファレンス」の「6.5.3 HCSC-Manager定義ファイル」を参照してください。また,ログファイルのローテーション方式などの設定については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」を参照してください。
(c) インストールログ
必ず出力されます。
(d) メソッドトレース
メソッドトレースは必ず出力されます。メソッドトレースは,出力される出力先やファイルのサイズ,面数,および出力レベルを決める必要があります。HCSCサーバランタイム定義ファイルの次のプロパティを指定します。
HCSCサーバランタイム定義ファイルの次のプロパティを指定します。
-
methodtrace-filepath=メソッドトレース・例外ログの出力先パス
-
methodtrace-filesize=メソッドトレースファイルサイズ
-
methodtrace-filenum=メソッドトレースファイル面数
-
methodtrace-level=メソッドトレースの出力レベル
HCSCサーバランタイム定義ファイルの詳細については,マニュアル「サービスプラットフォーム リファレンス」の「6.5.6 HCSCサーバランタイム定義ファイル」を参照してください。また,トレースファイルのローテーション方式などの設定については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」を参照してください。
(e) 保守情報
障害を調査するために必要となる保守情報を次の表に示します。
保守情報 |
対象データの出力先 |
---|---|
HCSCサーバリポジトリ情報 |
<サービスプラットフォームのインストールディレクトリ>\CSC\repository配下のすべてのファイルおよびディレクトリ※1 |
HCSC-Managerの保守情報 |
<サービスプラットフォームのインストールディレクトリ>\CSC\config\manager配下のすべてのファイルおよびディレクトリ |
HCSCサーバ保持情報 |
<サービスプラットフォームのインストールディレクトリ>\CSC\spool配下のすべてのファイルおよびディレクトリ |
<サービスプラットフォームのインストールディレクトリ>\CSC\system配下のすべてのファイルおよびディレクトリ |
|
HCSCサーバセットアップ定義ファイルのhcscserver-data-filepathプロパティで指定したフォルダ配下の,すべてのファイルおよびディレクトリ※2 |
(9) ユーザ認証情報管理コマンドのメッセージログの取得方法
次に示すユーザ認証情報管理コマンドを実行すると,ユーザ認証情報管理コマンドのメッセージログに実行時の情報(通知・エラーなど)がメッセージとして出力されます。
-
csakeyaddコマンド(公開鍵認証の秘密鍵情報の登録・更新)
-
csakeydelコマンド(公開鍵認証の秘密鍵情報の削除)
-
csakeylsコマンド(公開鍵認証の秘密鍵情報の表示)
-
csauseraddコマンド(パスワード認証のユーザ情報の登録・更新)
-
csauserdelコマンド(パスワード認証のユーザ情報の削除)
-
csauserlsコマンド(パスワード認証のユーザ情報の表示)
このメッセージログを参照することで,過去に実行したコマンドの障害情報や稼働情報を確認できます。
ユーザ認証情報管理コマンドのメッセージログは,ユーザ認証情報管理コマンド定義ファイルで,ファイルのサイズや面数などを指定します。
-
authinfo.command.messagelog.filesize=メッセージログファイルサイズ
-
authinfo.command.messagelog.filenum=メッセージログファイル面数
出力されたユーザ認証情報管理コマンドのメッセージログの確認方法については,「7.4.8 ユーザ認証情報管理コマンドのメッセージログ」を参照してください。ユーザ認証情報管理コマンド定義ファイルの詳細については,マニュアル「サービスプラットフォーム リファレンス」の「6.17.1 ユーザ認証情報管理コマンド定義ファイル」を参照してください。
(10) アカウント情報管理コマンドのメッセージログの取得方法
次に示すアカウント情報管理コマンドを実行すると,アカウント情報管理コマンドのメッセージログに実行時の情報(通知・エラーなど)がメッセージとして出力されます。
-
csahttpuseraddコマンド(HTTPアダプタのベーシック認証で使用するアカウント情報の登録・更新)
-
csahttpuserdelコマンド(HTTPアダプタのベーシック認証で使用するアカウント情報の削除)
-
csahttpuserlsコマンド(HTTPアダプタのベーシック認証で使用するアカウント情報の表示)
このメッセージログを参照することで,過去に実行したコマンドの障害情報や稼働情報を確認できます。
アカウント情報管理コマンドのメッセージログは,アカウント情報管理コマンド定義ファイルで,出力先ディレクトリ,ファイルのサイズおよび面数を指定します。
-
authinfo.command.messagelog.filepath=メッセージログファイルの出力先ディレクトリの絶対パス
-
authinfo.command.messagelog.filesize=メッセージログファイルサイズ
-
authinfo.command.messagelog.filenum=メッセージログファイル面数
出力されたアカウント情報管理コマンドのメッセージログの確認方法については,「7.4.9 アカウント情報管理コマンドのメッセージログ」を参照してください。アカウント情報管理コマンド定義ファイルの詳細については,マニュアル「サービスプラットフォーム リファレンス」の「6.17.2 アカウント情報管理コマンド定義ファイル」を参照してください。