3.20.1 ログ出力アクティビティ定義ファイル
- 〈この項の構成〉
(1) 形式
log-activity.<ログ出力識別子>.filepath=ログ出力アクティビティのログファイルの出力先パス
［log-activity.<ログ出力識別子>.filesize=ログ出力アクティビティのログファイルの1面当たりのファイルサイズ］
［log-activity.<ログ出力識別子>.filenum=ログ出力アクティビティのログファイルのバックアップファイルの面数］
［log-activity.<ログ出力識別子>.level={TRACE｜DEBUG｜INFO｜WARN｜ERROR｜FATAL}］
［log-activity.<ログ出力識別子>.message-definition-filepath=メッセージ定義ファイルのファイルパス］
(2) 機能
ログ出力アクティビティで任意のメッセージを出力する場合に，出力するファイルの情報をログ出力アクティビティ定義ファイルで設定します。
［ログ出力アクティビティ］ダイアログと各定義ファイルの関係，およびログファイルの出力結果については，マニュアル「サービスプラットフォーム 解説」の「3.9 ログ出力アクティビティでのログ出力」を参照してください。
また，［ログ出力アクティビティ］ダイアログの指定方法については，「1.4.19 ログ出力アクティビティダイアログ」を参照してください。
(a) 作成手順
ログ出力アクティビティ定義ファイルの作成から，ログ出力アクティビティに割り当てるまでの流れを次に示します。
-
次のテンプレートファイルを基に，ログ出力アクティビティ定義ファイルを定義します。
<サービスプラットフォームのインストールディレクトリ>\CSC\config\bp\templates\log_activity_definition.properties
各プロパティのキー部分にはログ出力識別子を指定します。ログ出力識別子の指定については，「(b) ログ出力識別子の定義」を参照してください。
各プロパティの指定方法については，「(3) 設定できるプロパティ」を参照してください。
-
編集後のファイルをファイル名「log_activity_definition.properties」で任意のディレクトリに格納してください。
-
ログ出力アクティビティ定義ファイルのパスをHCSCサーバランタイム定義ファイルのbp-log-activity-definition-filepathプロパティに指定します。
bp-log-activity-definition-filepathプロパティについては，「6.5.6 HCSCサーバランタイム定義ファイル」を参照してください。
-
ログ出力アクティビティの定義時に，［ログ出力アクティビティ］ダイアログの［ログ出力識別子］にログ出力識別子を指定します。
ログ出力アクティビティ定義ファイルに記述したログ出力識別子を指定してください。
複数のログ出力アクティビティから，1つのログ出力識別子を指定することもできます。これによって，複数のログ出力アクティビティから同じログファイルに出力させることができます。
なお，ログ出力アクティビティ定義ファイルの定義内容は，HCSCサーバの次回起動時から有効になります。
(b) ログ出力識別子の定義
ログ出力識別子は，ログ出力アクティビティのログの出力先を一意に識別する文字列です。
ログ出力識別子には，次の条件を満たす値を指定してください。条件を満たさない値を指定した場合の動作は保証しません。
-
ログ出力識別子は最大20文字で指定してください。使用できる文字は，半角英数字およびアンダーバー（_）です。
-
複数のログ出力識別子で，同一のログ出力先を指定しないでください。
-
複数のHCSCサーバで，同一のログ出力先を指定しないでください。
定義されたログ出力識別子は，ログ出力アクティビティの定義時に［ログ出力アクティビティ］ダイアログの画面項目［ログ出力識別子］に指定することで有効になります。
(3) 設定できるプロパティ
log-activity.<ログ出力識別子>.filepath=ログ出力アクティビティのログファイルの出力先パス
ログファイルの出力先のファイルパスをファイル名も含めて設定します。パスを指定する場合の注意事項を次に示します。
-
相対パス，親ディレクトリ表現（「..\」，「../」），およびカレントディレクトリ表現（「.\」，「./」）を含むパスは指定しないでください。
-
シンボリックリンクを含むパスは指定しないでください。
-
Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。
出力先として指定されたディレクトリが存在しない場合は，自動的に作成されます。
指定された出力先ファイルを開けなかった場合は，HCSCサーバの起動に失敗します。
なお，ログファイルのファイル名は，ローテーション方式に応じて次のようになります。
-
ラップアラウンドモードの場合：「ファイル名<面数>.log」
-
シフトモードの場合：「ファイル名.log」
log-activity.<ログ出力識別子>.filesize=ログ出力アクティビティのログファイルの1面当たりのファイルサイズ 〜＜数字＞((4096−2147483647))<<2097152>>
ログファイルの1面当たりのファイルサイズを設定します。不正な値を指定した場合，HCSCサーバの起動に失敗します。
log-activity.<ログ出力識別子>.filenum=ログ出力アクティビティのログファイルのバックアップファイルの面数 〜＜数字＞((1−16))<<4>>
ログファイルのバックアップファイルの面数を設定します。不正な値を指定した場合，HCSCサーバの起動に失敗します。
log-activity.<ログ出力識別子>.level={TRACE｜DEBUG｜INFO｜WARN｜ERROR｜FATAL} 〜<<ERROR>>
ログの出力レベルを次の中から設定します。不正な値を指定した場合，HCSCサーバの起動に失敗します。
-
TRACE
-
DEBUG
-
INFO
-
WARN
-
ERROR
-
FATAL
ログ出力アクティビティ定義ファイルとメッセージ定義ファイルの間で異なる出力レベルが設定された場合，次のように出力されます。
|
ログ出力アクティビティ定義ファイルの出力レベルの指定 |
メッセージ定義ファイルの出力レベルの指定 |
|||||
|---|---|---|---|---|---|---|
|
TRACE |
DEBUG |
INFO |
WARN |
ERROR |
FATAL |
|
|
TRACE |
○ |
○ |
○ |
○ |
○ |
○ |
|
DEBUG |
× |
○ |
○ |
○ |
○ |
○ |
|
INFO |
× |
× |
○ |
○ |
○ |
○ |
|
WARN |
× |
× |
× |
○ |
○ |
○ |
|
ERROR |
× |
× |
× |
× |
○ |
○ |
|
FATAL |
× |
× |
× |
× |
× |
○ |
- （凡例）
-
○：出力されます。
×：出力されません。
log-activity.<ログ出力識別子>.message-definition-filepath=メッセージ定義ファイルのファイルパス
出力するメッセージがメッセージ定義ファイルに定義されている場合に，メッセージ定義ファイルのファイルパスを指定します。
このプロパティは，ログ出力アクティビティの定義時に［ログ出力アクティビティ］ダイアログで［リソースKey］を選択する場合に必要です。［任意の文字列］を選択してメッセージをダイアログ上に直接指定する場合は，このプロパティは指定不要です。
パスを指定する場合の注意事項を次に示します。
-
相対パス，親ディレクトリ表現（「..\」，「../」），およびカレントディレクトリ表現（「.\」，「./」）を含むパスは指定しないでください。
-
シンボリックリンクを含むパスは指定しないでください。
-
Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。
存在しないファイルパスを指定した場合や，入力形式に沿っていない場合は，HCSCサーバの起動に失敗します。