7.1. ログ出力¶

ログの種類¶
ログの種類	説明
障害通知ログ	障害発生時に1次切り分け担当者を特定するのに必要な情報を出力する。
障害解析ログ	障害原因の特定に必要な情報を出力する。
SQLログ	深刻なパフォーマンス劣化の要因となりやすいSQL文の実行について、パフォーマンスチューニングに使用するために、SQL文の実行時間とSQL文を出力する。
パフォーマンスログ	任意の処理について、パフォーマンスチューニングに使用するために実行時間とメモリ使用量を出力する。
HTTPアクセスログ	ウェブアプリケーションで、アプリケーションの実行状況を把握するための情報を出力する。アプリケーションの性能測定に必要な情報、アプリケーションの負荷測定に必要な情報の出力も含む。さらに、アプリケーションの不正使用を検知するために、全てのリクエスト及びレスポンス情報を出力する証跡ログとしても使用する。
メッセージングログ	メッセージング処理において、メッセージ送受信の状況を把握するための情報を出力する。

ちなみに

本フレームワークでは、障害通知ログと障害解析ログを合わせて障害ログと呼ぶ。

7.1.2. モジュール一覧 ¶

<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-core</artifactId>
</dependency>
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-core-applog</artifactId>
</dependency>

<!-- SQLログを使用する場合のみ -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-core-jdbc</artifactId>
</dependency>

<!-- HTTPアクセスログを使用する場合のみ -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-fw-web</artifactId>
</dependency>

<!-- メッセージングログを使用する場合のみ -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-fw-messaging</artifactId>
</dependency>

7.1.4. 拡張例 ¶

7.1.4.1. LogWriterを追加する ¶

新しいLogWriterを追加する場合は、 LogWriter インタフェースを実装したクラスを作成する。また、 LogFormatter を使用するLogWriterを作成する場合は、共通処理を提供する LogWriterSupport を継承して作成する。

7.1.4.2. LogFormatterを追加する ¶

新しいLogFormatterを追加する場合は、 LogFormatter インタフェースを実装したクラスを作成する。また、ログレベルを表す文言を設定で変更可能にしたい場合は、 LogLevelLabelProvider を使用する。

新しいLogFormatterの追加に伴い、ログ出力時に指定するパラメータを増やし、 LogFormatterで増やしたパラメータを受け取りたいことがある。本機能では、ログ出力時に指定するパラメータを増やす目的で、 Logger インタフェースのログ出力メソッドに Object型の可変長引数optionsを設けている。

// Logger#logInfoメソッドのシグネチャ
public void logInfo(String message, Object... options)
public void logInfo(String message, Throwable cause, Object... options)

ログ出力時のパラメータを増やしたい場合は、options引数を規定して使用すること。

7.1.4.3. ログの出力項目(プレースホルダ)を追加する ¶

BasicLogFormatter は、 LogItem インタフェースを使用して、各プレースホルダに対応する出力項目を取得する。そのため、新規にプレースホルダを追加したい場合は、以下の作業を行う。

LogItem を実装したクラスを作る
BasicLogFormatter を継承したクラスを作り、プレースホルダを追加する

LogFormatterの設定から起動プロセスを取得するように変更する場合の例を示す。 LogFormatterの設定は、下記を想定する。

# カスタムのLogFormatterを指定する。
writer.appLog.formatter.className=nablarch.core.log.basic.CustomLogFormatter

# フォーマットを指定する。
writer.appLog.formatter.format=$date$ -$logLevel$- $loggerName$ [$bootProcess$] $message$

# LogFormatterの設定で起動プロセスを指定する。
# ここで指定した起動プロセスを$bootProcess$に出力する。
writer.appLog.formatter.bootProcess=CUSTOM_PROCESS

LogItem を実装したクラスを作る

// カスタムの起動プロセスを取得するクラス。
public class CustomBootProcessItem implements LogItem<LogContext> {

    private String bootProcess;

    public CustomBootProcessItem(ObjectSettings settings) {
        // LogFormatterの設定から起動プロセスを取得する。
        bootProcess = settings.getProp("bootProcess");
    }

    @Override
    public String get(LogContext context) {
        // 設定から取得した起動プロセスを返す。
        return bootProcess;
    }
}

BasicLogFormatter を継承したクラスを作り、プレースホルダを追加する

public class CustomLogFormatter extends BasicLogFormatter {

    // フォーマット対象のログ出力項目を取得するメソッドをオーバーライドする。
    @Override
    protected Map<String, LogItem<LogContext>> getLogItems(ObjectSettings settings) {

        // 起動プロセスのプレースホルダを上書きで設定する。
        Map<String, LogItem<LogContext>> logItems = super.getLogItems(settings);
        logItems.put("$bootProcess$", new CustomBootProcessItem(settings));
        return logItems;
    }
}

7.1.5. SynchronousFileLogWriterを使用するにあたっての注意事項 ¶

重要

SynchronousFileLogWriter には以下の制約があるため、利用にあたっては十分検討すること。

ログのローテーションができない。
出力されるログの内容が正常でない場合がある。

SynchronousFileLogWriter は、ロックファイルを用いて排他制御を行いながらファイルにログを書き込む。そして、ロック取得の待機時間を超えてもロックを取得できない場合、強制的にロックファイルを削除し、自身のスレッド用のロックファイルを生成してからログの出力を行う。

もし強制的にロックファイルを削除できない場合は、ロックを取得していない状態で強制的にログの出力を行う。また、ロックファイルの生成に失敗した場合および、ロック取得待ちの際に割り込みが発生した場合も、ロックを取得していない状態で強制的にログの出力を行う。

ロックを取得しない状態で強制的にログを出力する場合に、複数プロセスからのログ出力が競合するとログが正常に出力されない場合がある点に注意すること。

このような障害が発生した場合には、強制出力したログに加えて、同一のログファイルに障害のログを出力する。デフォルトでは本フレームワークが用意したログが出力されるが、 SynchronousFileLogWriter のプロパティに障害コードを設定することで、障害通知ログのフォーマット(障害コードを含む)でログを出力することができる。障害通知ログのフォーマットで出力することで通常の障害通知ログと同様の方法でログの監視が可能となるので、障害コードの設定を行うことを推奨する。

障害コードを設定するプロパティ名を以下に示す。

failureCodeCreateLockFile

メッセージの設定例({0}にはロックファイルのパスが設定される):
障害の内容:	ロックファイルが生成できない
ログレベル:	FATAL
	ロックファイルの生成に失敗しました。おそらくロックファイルのパスが間違っています。ロックファイルパス=[{0}]。
デフォルトで出力するログ(障害コードなどは出力されない):
	failed to create lock file. perhaps lock file path was invalid. lock file path=[{0}].

failureCodeReleaseLockFile

メッセージの設定例({0}にはロックファイルのパスが設定される):
障害の内容:	生成したロックファイルを解放(削除)できない
ログレベル:	FATAL
	ロックファイルの削除に失敗しました。ロックファイルパス=[{0}]。
デフォルトで出力するログ(障害コードなどは出力されない):
	failed to delete lock file. lock file path=[{0}].

failureCodeForceDeleteLockFile

メッセージの設定例({0}にはロックファイルのパスが設定される):
障害の内容:	解放されないロックファイルを強制削除できない
ログレベル:	FATAL
	ロックファイルの強制削除に失敗しました。ロックファイルが不正に開かれています。ロックファイルパス=[{0}]。
デフォルトで出力するログ(障害コードなどは出力されない):
	failed to delete lock file forcedly. lock file was opened illegally. lock file path=[{0}].

failureCodeInterruptLockWait

デフォルトで出力するログ(障害コードなどは出力されない):
障害の内容:	ロック取得待ちでスレッドをスリープしている際に、割り込みが発生
ログレベル:	FATAL
メッセージの設定例:	ロック取得中に割り込みが発生しました。
	interrupted while waiting for lock retry.

重要

障害コードを設定した場合、障害通知ログのフォーマットで同一のログファイルにログが出力されるが、障害解析ログは出力されない点に注意すること。

SynchronousFileLogWriter の設定例を以下に示す。

writerNames=monitorLog

# SynchronousFileLogWriterクラスを指定する。
writer.monitorLog.className=nablarch.core.log.basic.SynchronousFileLogWriter
# 書き込み先のファイルパスを指定する。
writer.monitorLog.filePath=/var/log/app/monitor.log
# 書き込み時に使用する文字エンコーディングを指定する。
writer.monitorLog.encoding=UTF-8
# 出力バッファのサイズを指定する。(単位はキロバイト。1000バイトを1キロバイトと換算する。指定しなければ8KB)
writer.monitorLog.outputBufferSize=8
# ログフォーマッタのクラス名を指定する。
writer.monitorLog.formatter.className=nablarch.core.log.basic.BasicLogFormatter
# LogLevel列挙型の名称を指定する。ここで指定したレベル以上のログを全て出力する。
writer.monitorLog.level=ERROR
# ロックファイルのファイル名を指定する。
writer.monitorLog.lockFilePath=/var/log/lock/monitor.lock
# ロック取得の再試行間隔(ミリ秒)を指定する。
writer.monitorLog.lockRetryInterval=10
# ロック取得の待機時間(ミリ秒)を指定する。
writer.monitorLog.lockWaitTime=3000
# ロックファイルが生成できない場合の障害通知コードを指定する。
writer.monitorLog.failureCodeCreateLockFile=MSG00101
# 生成したロックファイルを解放(削除)できない場合の障害通知コードを指定する。
writer.monitorLog.failureCodeReleaseLockFile=MSG00102
# 解放されないロックファイルを強制削除できない場合の障害通知コードを指定する。
writer.monitorLog.failureCodeForceDeleteLockFile=MSG00103
# ロック待ちでスレッドをスリープしている際に、割り込みが発生した場合の障害通知コードを指定する。
writer.monitorLog.failureCodeInterruptLockWait=MSG00104

重要

maxFileSizeプロパティを指定するとログのローテーションが発生し、ログの出力が出来なくなることがあるので指定しないこと。

7.1.6. ログレベルの定義 ¶

本機能では、以下のログレベルを使用する。

ログレベルの定義¶
ログレベル	説明
FATAL	アプリケーションの継続が不可能になる深刻な問題が発生したことを示す。監視が必須で即通報および即対応が必要となる。
ERROR	アプリケーションの継続に支障をきたす問題が発生したことを示す。監視が必須であるが、通報および対応にFATALレベルほどの緊急性がない。
WARN	すぐには影響を与えないが、放置しておくとアプリケーションの継続に支障をきたす問題になる恐れがある事象が発生したことを示す。できれば監視した方がよいが、ERRORレベルほどの緊急性がない。
INFO	本番運用時にアプリケーションの情報を出力するログレベル。アクセスログや統計ログが該当する。
DEBUG	開発時にデバッグ情報を出力するログレベル。SQLログや性能ログが該当する。
TRACE	開発時にデバッグ情報より、さらに細かい情報を出力したい場合に使用するログレベル。

ログレベルは、6段階とし、FATALからTRACEに向かって順にレベルが低くなる。そして、ログ出力機能では、設定で指定されたレベル以上のログを全て出力する。例えば、WARNレベルが設定で指定された場合は、FATALレベル,ERRORレベル,WARNレベルが指定されたログのみ出力する。

ちなみに

本番運用時は、INFOレベルでログを出力することを想定している。ログファイルのサイズが肥大化しないように、プロジェクト毎にログの出力内容を規定すること。

ちなみに

本フレームワークでも、ログ出力機能を使ってログを出力している。フレームワークが出力するログについては、フレームワークのログ出力方針を参照すること。

7.1.7. フレームワークのログ出力方針 ¶

本フレームワークでは、下記の出力方針に基づきログ出力を行う。

フレームワークのログ出力方針¶
ログレベル	出力方針
FATAL/ERROR	障害ログの出力時にFATAL/ERRORレベルで出力する。障害ログは、障害監視の対象であり、障害発生時の一時切り分けの起点ともなる為、原則として1件の障害に対して、1件の障害ログを出力する方針としている。このため、実行制御基盤では単一のハンドラ(例外を処理するハンドラ)により、障害通知ログを出力する方針としている。
WARN	障害発生時に連鎖して例外が発生した場合など、障害ログとして出力できない例外をWARNレベルで出力する。例えば、業務処理とトランザクションの終了処理の2つで例外が発生した場合は、業務処理の例外を障害ログに出力し、トランザクションの終了処理の例外をWARNレベルで出力する。
INFO	アプリケーションの実行状況に関連するエラーを検知した場合にINFOレベルで出力する。例えば、URLパラメータの改竄エラーや認可チェックエラーが発生した場合にINFOレベルで出力する。
DEBUG	アプリケーション開発時に使用するデバッグ情報を出力する。アプリケーション開発時は、DEBUGレベルを設定することで開発に必要な情報が出力されるよう考慮している。
TRACE	フレームワーク開発時に使用するデバッグ情報を出力する。アプリケーション開発での使用は想定していない。

7.1.8. log4jとの機能比較 ¶

ここでは、本機能と log4j(外部サイト、英語) との機能比較を示す。

機能比較（○：提供あり　△：一部提供あり　×：提供なし　－:対象外）¶
機能	Nablarch	log4j
ログの出力有無をログレベルで制御できる	○ 解説書へ	○
ログの出力有無をカテゴリ(パッケージ単位や名前など)で制御できる	○ 解説書へ	○
1つのログを複数の出力先に出力できる	○ 解説書へ	○
ログを標準出力に出力できる	○ 解説書へ	○
ログをファイルに出力できる	○ 解説書へ	○
ファイルサイズによるログファイルのローテーションができる	△ [1] 解説書へ	○
日時によるログファイルのローテーションができる	× [2]	○
ログをメールで送信できる	× [2]	○
ログをTelnetで送信できる	× [2]	○
ログをSyslogで送信できる	× [2]	○
ログをWindows NTのイベントログに追加できる	× [2]	○
データベースにログを出力できる	× [2]	○
ログを非同期で出力できる	× [2]	○
ログのフォーマットをパターン文字列で指定できる	○ 解説書へ	○
障害ログを出力できる	○ 解説書へ	－
HTTPアクセスログを出力できる	○ 解説書へ	－
SQLログを出力できる	○ 解説書へ	－
パフォーマンスログを出力できる	○ 解説書へ	－
メッセージングログを出力できる	○ 解説書へ	－

[1]	Nablarchのログ出力は、ファイルの世代管理を提供していないので、一部提供ありとしている。

[2]	(1, 2, 3, 4, 5, 6, 7) log4jアダプタを使用する。または、プロジェクトで作成する。作成方法は、 LogWriterを追加するを参照。

7.1. ログ出力¶

7.1.1. 機能概要 ¶

7.1.1.1. ログ出力機能の実装を差し替えることができる ¶

7.1.1.2. 各種ログの出力機能を予め提供している ¶

7.1.2. モジュール一覧 ¶

7.1.3. 使用方法 ¶

7.1.3.1. ログを出力する ¶

7.1.3.2. ログ出力の設定を行う ¶

7.1.3.3. ログ出力の設定を上書く ¶

7.1.3.4. ログのフォーマットを指定する ¶

7.1.3.5. 各種ログの設定を行う ¶

7.1.4. 拡張例 ¶

7.1.4.1. LogWriterを追加する ¶

7.1.4.2. LogFormatterを追加する ¶

7.1.4.3. ログの出力項目(プレースホルダ)を追加する ¶

7.1.5. SynchronousFileLogWriterを使用するにあたっての注意事項 ¶

7.1.6. ログレベルの定義 ¶

7.1.7. フレームワークのログ出力方針 ¶

7.1.8. log4jとの機能比較 ¶