7.1. ログ出力¶

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

ログ出力は、３つの処理から構成されており、それぞれの実装を差し替えることができる。

アプリケーションの要件に応じて、 LogWriter や LogFormatter の単位で差し替えることもできるし、 これらだけでは要件を満たせなければ Logger / LoggerFactory を実装してほぼ全ての処理を差し替えることもできる。

例えば、オープンソースのログ出力ライブラリを使用したい場合などは Logger / LoggerFactory を差し替えればよい。

なお、オープンソースで使用実績の多いロギングフレームワークは、専用のLogger/LoggerFactoryを既に用意している。

詳細は、logアダプタ を参照。

本機能と使用実績の多いlog4jとの機能比較は、 log4jとの機能比較 を参照。

ログ出力機能がデフォルトで提供しているクラスを示す。

Logger/LoggerFactory

• BasicLogger
• BasicLoggerFactory

LogWriter

• FileLogWriter (ファイルへ出力。ログのローテーション。)
• SynchronousFileLogWriter (複数プロセスから1ファイルへの出力)
• StandardOutputLogWriter (標準出力へ出力)
• LogPublisher (任意のリスナーへ出力)

LogFormatter

• BasicLogFormatter (パターン文字列によるフォーマット)

RotatePolicy

• DateRotatePolicy (日時によるログのローテーション)
• FileSizeRotatePolicy (ファイルサイズによるログのローテーション)

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

本フレームワークでは、アプリケーションに共通で必要とされる各種ログの出力機能を予め提供している。 アプリケーションの要件に応じて、ログのフォーマットを設定で変更して使用できる。 なお、各種ログの設定 にも記載の通り、各種ログの出力機能はフォーマット処理のみを行っており、 ログの出力処理自体は本機能を使用している。 Nablarchの提供するアーキタイプから生成したブランクプロジェクトでは各種ログのフォーマットが設定してある。 各設定値は デフォルト設定一覧 を参照。

7.1.3.1. ログを出力する¶

ログの出力には Logger を使用する。 Logger は LoggerManager から取得する。

// クラスを指定してLoggerを取得する。
// Loggerはクラス変数に保持する。
private static final Logger LOGGER = LoggerManager.get(UserManager.class);

// ログの出力有無を事前にチェックし、ログ出力を行う。
if (LOGGER.isDebugEnabled()) {
    String message = "userId[" + user.getId() + "],name[" + user.getName() + "]";
    LOGGER.logDebug(message);
}

Logger の取得ではロガー名を指定する。 ロガー名には文字列またはクラスが指定できる。 クラスが指定された場合は、指定されたクラスのFQCNがロガー名となる。

7.1.3.2. ログ出力の設定¶

ログ出力の設定は、プロパティファイルに行う。

プロパティファイルの場所

クラスパス直下の log.properties を使用する。 場所を変更したい場合は、システムプロパティで nablarch.log.filePath をキーにファイルパスを指定する。 ファイルパスの指定方法は FileUtil#getResource を参照。

>java -Dnablarch.log.filePath=classpath:nablarch/example/log.properties ...

プロパティファイルの記述ルール

プロパティファイルの記述ルールを以下に示す。

LoggerFactory

記述ルール

loggerFactory.className

LoggerFactoryを実装したクラスのFQCNを指定する。 本機能を使う場合は、 BasicLoggerFactory を指定する。

記述例

# LoggerFactoryにより、ログ出力に使用する実装(本機能やLog4Jなど)が決まる。
loggerFactory.className=nablarch.core.log.basic.BasicLoggerFactory

LogWriter

記述ルール

writerNames

使用する全てのLogWriterの名前を指定する。複数指定する場合はカンマ区切り。

writer.<名前>.className

LogWriterを実装したクラスのFQCNを指定する。

writer.<名前>.<プロパティ名>

LogWriter毎のプロパティに設定する値を指定する。 指定できるプロパティについては使用するLogWriterのJavadocを参照。

記述例

# 2つの名前を定義する。
writerNames=appLog,stdout

# appLogの設定を行う。
writer.appLog.className=nablarch.core.log.basic.FileLogWriter
writer.appLog.filePath=/var/log/app/app.log

# stdoutの設定を行う。
writer.stdout.className=nablarch.core.log.basic.StandardOutputLogWriter

ロガー設定

記述ルール

availableLoggersNamesOrder

使用する全てのロガー設定の名前を指定する。複数指定する場合はカンマ区切り。

重要

availableLoggersNamesOrderプロパティは、記述順に意味があるので注意すること。

Logger の取得では、ログ出力を行うクラスが指定したロガー名に対して、 ここに記述した順番で Logger のマッチングを行い、 最初にマッチした Logger を返す。

例えば、以下の記述例にあるavailableLoggersNamesOrderの記述順をavailableLoggersNamesOrder=root,sqlと記述した場合、 全てのロガー取得がロガー設定 root にマッチしてしまう。 その結果、ロガー名 SQL でログ出力しても sqlLog に出力されず、ロガー設定 root に指定された appLog に出力される。

したがって、availableLoggersNamesOrderプロパティは、より限定的な正規表現を指定したロガー設定から順に記述すること。

重要

availableLoggersNamesOrderとloggers.*で指定するロガー設定の名称は、必ず一致させる必要がある。 BasicLoggerFactory の初期処理で一致しているかチェックを行い、 一致しない場合は例外をスローする。 例えば、上記の設定にあるavailableLoggersNamesOrderから access を取り除くと、例外がスローされる。

このチェックは、設定漏れの発生を防ぐために行っている。 上記の設定にあるavailableLoggersNamesOrderから access を取り除いた場合は、明示的にloggers.access.*の設定も取り除く必要がある。

loggers.<名前>.nameRegex

ロガー名とのマッチングに使用する正規表現を指定する。 正規表現は、ロガー設定の対象となるロガーを絞り込むために使用する。 ロガーの取得時に指定されたロガー名(つまり LoggerManager#get の引数に指定されたロガー名)に対してマッチングを行う。

loggers.<名前>.level

LogLevel の名前を指定する。 ここで指定したレベル以上のログを全て出力する。

loggers.<名前>.writerNames

出力先とするLogWriterの名前を指定する。 複数指定する場合はカンマ区切り。 ここで指定した全てのLogWriterに対してログの書き込みを行う。

記述例

# 2つのロガー設定の名前を定義する。
availableLoggersNamesOrder=sql,root

# rootの設定を行う。
loggers.root.nameRegex=.*
loggers.root.level=WARN
loggers.root.writerNames=appLog

# sqlの設定を行う。
loggers.sql.nameRegex=SQL
loggers.sql.level=DEBUG
loggers.sql.writerNames=sqlLog

プロパティファイルの記述例

プロパティファイル全体の記述例を以下に示す。

loggerFactory.className=nablarch.core.log.basic.BasicLoggerFactory

writerNames=appLog,sqlLog,monitorLog,stdout

# アプリケーション用のログファイルの設定例
writer.appLog.className=nablarch.core.log.basic.FileLogWriter
writer.appLog.filePath=/var/log/app/app.log

# SQL出力用のログファイルの設定例
writer.sqlLog.className=nablarch.core.log.basic.FileLogWriter
writer.sqlLog.filePath=/var/log/app/sql.log

# 監視用のログファイルの設定例
writer.monitorLog.className=nablarch.core.log.basic.FileLogWriter
writer.monitorLog.filePath=/var/log/app/monitoring.log

# 標準出力の設定例
writer.stdout.className=nablarch.core.log.basic.StandardOutputLogWriter

availableLoggersNamesOrder=sql,monitoring,access,validation,root

# 全てのロガー名をログ出力の対象にする設定例
# 全てのロガー取得を対象に、WARNレベル以上をappLogに出力する。
loggers.root.nameRegex=.*
loggers.root.level=WARN
loggers.root.writerNames=appLog

# 特定のロガー名をログ出力の対象にする設定例。
# ロガー名に"MONITOR"を指定したロガー取得を対象に、
# ERRORレベル以上をappLog,monitorLogに出力する。
loggers.monitoring.nameRegex=MONITOR
loggers.monitoring.level=ERROR
loggers.monitoring.writerNames=appLog,monitorLog

# 特定のロガー名をログ出力の対象にする設定例。
# ロガー名に"SQL"を指定したロガー取得を対象に、
# DEBUGレベル以上をsqlLogに出力する。
loggers.sql.nameRegex=SQL
loggers.sql.level=DEBUG
loggers.sql.writerNames=sqlLog

# 特定のクラスをログ出力の対象にする設定例。
# ロガー名に"app.user.UserManager"を指定したロガー取得を対象に、
# INFOレベル以上をappLogとstdoutに出力する。
loggers.access.nameRegex=app\\.user\\.UserManager
loggers.access.level=INFO
loggers.access.writerNames=appLog,stdout

# 特定のパッケージ以下をログ出力の対象にする設定例。
# ロガー名に"nablarch.core.validation"から始まる名前を指定したロガー取得を対象に、
# DEBUGレベル以上をstdoutに出力する。
loggers.validation.nameRegex=nablarch\\.core\\.validation\\..*
loggers.validation.level=DEBUG
loggers.validation.writerNames=stdout

補足

ロガー設定では、全てのログ出力にマッチするロガー設定を1つ用意し、availableLoggersNamesOrderの最後に指定することを推奨する。 万が一設定が漏れた場合でも、重要なログの出力を逃してしまう事態を防ぐことができる。 設定例としては、上記の記述例にあるロガー設定 root を参照。

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

ログ出力の設定は、システムプロパティを使用して、 プロパティファイルと同じキー名で値を指定することにより上書きできる。 これにより、共通のプロパティファイルを用意しておき、プロセス毎にログ出力設定を変更するといったことができる。

ロガー設定 root のログレベルをINFOに変更したい場合の例を以下に示す。

>java -Dloggers.root.level=INFO ...

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

本機能では、汎用的に使用できる LogFormatter として、 BasicLogFormatter を提供している。

BasicLogFormatter では、 プレースホルダを使用してフォーマットを指定する。 使用できるプレースホルダについては、 BasicLogFormatter のJavadocを参照。

フォーマットの設定例を以下に示す。 フォーマットはLogWriterのプロパティに指定する。

# フォーマットを指定する場合はBasicLogFormatterを明示的に指定する。
writer.appLog.formatter.className=nablarch.core.log.basic.BasicLogFormatter

# プレースホルダを使ってフォーマットを指定する。
writer.appLog.formatter.format=$date$ -$logLevel$- $loggerName$ $message$

# 日時のフォーマットに使用するパターンを指定する。
# 指定しなければ"yyyy-MM-dd HH:mm:ss.SSS"となる。
writer.appLog.formatter.datePattern=yyyy/MM/dd HH:mm:ss[SSS]

# ログレベルの文言を指定する。
# 指定しなければLogLevel列挙型の名前(FATAL、INFOなど)となる。
writer.appLog.formatter.label.fatal=F
writer.appLog.formatter.label.error=E
writer.appLog.formatter.label.warn=W
writer.appLog.formatter.label.info=I
writer.appLog.formatter.label.debug=D
writer.appLog.formatter.label.trace=T

BasicLogFormatter では、出力されたログの状況を特定するために、以下の項目を出力できる。 これらの出力項目について説明しておく。

• 起動プロセス
• 処理方式
• 実行時ID

起動プロセス

起動プロセスとは、アプリケーションを起動した実行環境を特定するために使用する名前である。 起動プロセスにサーバ名とJOBIDなどの識別文字列を組み合わせた名前を使用することで、 同一サーバの複数プロセスから出力されたログの実行環境を特定できる。 起動プロセスは、プロジェクト毎にID体系などで体系を規定することを想定している。

起動プロセスは、システムプロパティに nablarch.bootProcess というキーで指定する。 システムプロパティの指定がない場合、起動プロセスはブランクとなる。

処理方式

処理方式とは、ウェブ、バッチなどを意味する。 アプリケーションの処理方式を識別したい場合に、プロジェクト毎に規定して使用する。

処理方式は、 ログ出力の設定 で説明したプロパティファイルに nablarch.processingSystem というキーで指定する。 プロパティの指定がない場合はブランクとなる。

実行時ID

実行時IDとは、リクエストIDに対するアプリケーションの個々の実行を識別するためにつけるIDである。 1つのリクエストIDに対して実行された数だけ実行時IDが発行されるため、 リクエストIDと実行時IDの関係は1対多となる。

実行時IDは、複数のログを出力している場合に、出力された複数のログを紐付けるために使用する。

実行時IDは、各処理方式の ThreadContext を初期化するタイミングで発行し、 ThreadContext に設定される。

実行時IDのID体系

# 起動プロセスは指定された場合のみ付加する。
起動プロセス＋システム日時(yyyyMMddHHmmssSSS)＋連番(4桁)

改行コードとタブ文字を含めたい場合

フォーマットに改行コードとタブ文字を含めたい場合は、以下に示すように、Javaと同様の記述を使用する。

改行コード \n
タブ文字   \t

改行コードは、Java標準のシステムプロパティに含まれる line.separator から取得する。 このため、システムプロパティの line.separator を変更しなければOSの改行コードが使用される。

補足

BasicLogFormatter では \n と \t という文字列は出力できない。

7.1.3.5. 各種ログの設定¶

各種ログの出力機能は、各種ログの用途に合わせたフォーマット処理のみを行っており、 ログの出力処理自体は本機能を使用している。 つまり、各種ログの出力機能では、 Logger に指定するメッセージを作成する。

このため、各種ログの出力機能を使うには、 ログ出力の設定 に加えて、各種ログの設定が必要となる。 各種ログの設定は、プロパティファイルに行う。

プロパティファイルの場所

クラスパス直下の app-log.properties を使用する。 場所を変更したい場合は、システムプロパティで nablarch.appLog.filePath をキーにファイルパスを指定する。 ファイルパスの指定方法は FileUtil#getResource を参照。

>java -Dnablarch.appLog.filePath=file:/var/log/app/app-log.properties ...

プロパティファイルの記述ルール

各種ログごとに異なるので、以下を参照。

• 障害ログの設定
• SQLログの設定
• パフォーマンスログの設定
• HTTPアクセスログの設定
• HTTPアクセスログ（RESTfulウェブサービス用）の設定
• メッセージングログの設定

7.1.3.6. ログファイルのローテーションを行う¶

本機能で提供するFileLogWiterは、設定したポリシーに従ってログファイルのローテーションを行う。

ローテーションポリシーはデフォルトではファイルサイズによるローテーションを行う FileSizeRotatePolicy が使用される。 RotatePolicy の実装クラスを作成することで、ローテーションポリシーを変更することができる。

本機能が提供している RotatePolicy の実装クラスは以下。 各 RotatePolicy の設定はそれぞれのJavadocを参照。

• FileSizeRotatePolicy
• DateRotatePolicy

ローテーションポリシーの設定例を以下に示す。ローテーションポリシーはLogWriterのプロパティに指定する。

writerNames=sample

# writerのrotatePolicyにRotatePolicyが実装されたクラスのFQCNを指定する
writer.sample.rotatePolicy=nablarch.core.log.basic.DateRotatePolicy
# 更新時刻。オプション。
writer.sample.rotateTime=12:00

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.4.4. ログの初期化メッセージを出力しないようにする¶

本機能では、各ロガーの初期化時に初期化メッセージをログに出力している。 監視対象のログなどで、初期化メッセージが不要な場合には本機能が提供するWriterを元に、 初期化メッセージを出力しないWriterを作成し対応する必要がある。

なお、WebアプリケーションサーバなどやOSS製品とロガーを統一する目的などで logアダプタ を使用した場合は初期化メッセージは出力されないため、本対応は必要無い。

対応例を以下に示す。

1. ベースとなるWriterクラスのソースコードをプロジェクト側に取り込む(コピーする)。 例えば、ファイルに出力するログの場合には、 FileLogWriter をコピーする。

2. 初期化ログを出力している箇所を削除する。

   FileLogWriter の場合は、 以下の修正例のように初期化メッセージを出力している箇所を削除する。

   private void initializeWriter() {
     try {
       out = new BufferedOutputStream(new FileOutputStream(filePath, true), outputBufferSize);
       currentFileSize = new File(filePath).length();
   
       // ここで行っていた初期化メッセージの出力処理を削除する
   
     } catch (IOException e) {
       throw new IllegalArgumentException(String.format("failed to create %s. file name = [%s], encoding = [%s], buffer size =[%s]",
           Writer.class.getName(), filePath, charset.displayName(), outputBufferSize), e);
     }
   }
   

3. ログ機能初期化後の初期化メッセージを出力しないよう変更する。

needsToWrite をオーバライドし、 初回に呼び出される初期化メッセージの出力を行わないよう変更する。

/** 初回判定を行う為のフラグを定義する */
private boolean suppressionWriting = true;

@Override
public boolean needsToWrite(final LogContext context) {
  final String message = context.getMessage();
  if (suppressionWriting) {
    // 出力対象のログが「initialized.」から始まっていた場合は、
    // 初期化メッセージであるため出力対象外であることを示す「false」を戻す。
    if (StringUtil.hasValue(message) && message.startsWith("initialized.")) {
      suppressionWriting = false;
      return false;
    }
  }
  return super.needsToWrite(context);
}

4. 作成したクラスをlog.propertiesに設定する。

プロジェクト側で作成したWriterのクラス名を、log.propertiesに設定する。

設定例を以下に示す。

writerNames=sample

# writerのクラス名に作成したクラスを指定する
# クラスの完全修飾名が「sample.CustomFileLogWriter」の場合の設定例
writer.sample.className = sample.CustomFileLogWriter

7.1.5.1. LogWriterで使用するフォーマッタをJsonLogFormatterに変更する¶

LogWriterで使用するフォーマッタを JsonLogFormatter に変更することで、 ログの出力をJSON形式にできる。

使用方法

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

# JSON形式でログを出力する場合はJsonLogFormatterを指定する。
writer.appLog.formatter.className=nablarch.core.log.basic.JsonLogFormatter

# 出力項目を指定する。
writer.appLog.formatter.targets=date,logLevel,message,information,stackTrace

# 日時のフォーマットに使用するパターンを指定する。
# 指定しなければ"yyyy-MM-dd HH:mm:ss.SSS"となる。
writer.appLog.formatter.datePattern=yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

JsonLogFormatter では、 targets プロパティにカンマ区切りで出力項目を指定する。 使用できる出力項目については、下記の通り。 なお、デフォルトでは全ての項目が出力される。

targetsプロパティで指定できる出力項目¶

出力項目	説明
date	このログ出力を要求した時点の日時。
logLevel	このログ出力のログレベル。
loggerName	このログ出力が対応するロガー設定の名称。
runtimeLoggerName	実行時に、 LoggerManager からロガー取得に指定した名称。
bootProcess	起動プロセスを識別する名前。
processingSystem	処理方式を識別する名前。
requestId	このログ出力を要求した時点のリクエストID。
executionId	このログ出力を要求した時点の実行時ID。
userId	このログ出力を要求した時点のログインユーザのユーザID。
message	このログ出力のメッセージ。
stackTrace	エラー情報に指定された例外オブジェクトのスタックトレース。
payload	オプション情報に指定されたオブジェクト。

補足

datePattern および label (ログレベルの文言指定)は、 BasicLogFormatter と同様に機能する。

記述例

// クラスを指定してLoggerを取得する。
// Loggerはクラス変数に保持する。
private static final Logger LOGGER = LoggerManager.get(UserManager.class);

LOGGER.logInfo("hello");

(出力結果)

{"date":"2021-02-04 12:34:56.789","logLevel":"INFO","message":"hello"}

項目を独自に追加する

出力対象に payload を含む場合、オプション情報に指定されたMap<String, Object>オブジェクトをJSONオブジェクトとして出力する。 オブジェクトの変換ルールは下記の通り。

出力可能なオブジェクト¶

出力可能なJavaのクラス	JSONによる出力
String	JSONの文字列として出力する。
Number 及びそのサブクラス （ Integer , Long , Short , Byte , Float , Double , BigDecimal , BigInteger , AtomicInteger , AtomicLong ）	toString() メソッドの戻り値をJSONの数値として出力する。 NaN及び無限大はJSONの文字列として出力する。
Boolean	JSONの真理値（ true / false ）として出力する。
Date Calendar 及びそのサブクラス LocalDateTime ※Java8以降	JSONの文字列として出力する。デフォルトの書式は、 "yyyy-MM-dd HH:mm:ss.SSS" 。 書式を変更する場合は、 datePattern プロパティにて指定する。
Map の実装クラス	JSONのオブジェクトとして出力する。 キーが String ではない場合や値が null となる場合は、キーも含め出力されない。 値として null を出力する場合は、プロパティ ignoreNullValueMember に false をセットする。
List の実装クラス、及び配列	JSONの配列として出力する。
null	JSONの null として出力する。 Map の値が null のとき、デフォルトでは出力対象外となる。
その他のオブジェクト	toString() メソッドの戻り値をJSONの文字列として出力する。

記述例

Map<String, Object> structuredArgs = new HashTable<String, Object>();
structuredArgs.put("key1", "value1");
structuredArgs.put("key2", 123);
structuredArgs.put("key3", true);
structuredArgs.put("key4", null);
structuredArgs.put("key5", new Date());
LOGGER.logInfo("addition fields", structuredArgs);

(出力結果)

{"date":"2021-02-04 12:34:56.789","logLevel":"INFO","message":"addition fields","key1":"value1","key2":123,"key3":true,"key5":"2021-02-04 12:34:56.789"}

補足

JsonLogFormatter を使用する場合、 オプション情報に Map < String , Object >以外のオプション情報をセットしないこと。 Map オブジェクトは複数指定することが出来るが、 キーが重複した場合はいずれかの値は無視され、出力されない。

7.1.5.2. 各種ログで使用するフォーマッタをJSONログ用に差し替える¶

各種ログは、メッセージ部分を個別の方法でフォーマットしている。 それぞれのフォーマットで使用しているフォーマッタをJSON用のフォーマッタに差し替えることで、各種ログが出力する内容もJSONログとして出力できるようになる。

各フォーマッタの具体的な設定方法については、下記表のそれぞれのリンク先を参照のこと。

各種ログのJSON版フォーマッタ¶

ログの種類	対応するフォーマッタ
障害ログ	FailureJsonLogFormatter
SQLログ	SqlJsonLogFormatter
パフォーマンスログ	PerformanceJsonLogFormatter
HTTPアクセスログ	HttpAccessJsonLogFormatter
HTTPアクセスログ（RESTfulウェブサービス用）	JaxRsAccessJsonLogFormatter
メッセージングログ	MessagingJsonLogFormatter

7.1.5.3. NablarchバッチのログをJSON形式にする¶

Nablarchバッチで出力するログをJSON形式にするには、上述のフォーマッタの設定に加えて下記のとおり修正する必要がある。

• ApplicationSettingLogFormatterをJSON用に切り替える
• LauncherLogFormatterをJSON用に切り替える
• CommitLoggerをJSON用に切り替える

以下で、それぞれの設定方法について説明する。