biz-Streamマニュアルライブラリ共通ガイド第4章 ログ設定4.2 定義概要

4.2 定義概要

定義概要

ログの設定は、appender とloggerという2つの部分に大きく分かれます。

LoggerとAppenderは定義名で関連付けられています。
Loggerでは出力するログの種類とレベル等を設定します。
Appenderでは出力するログの出力先等を設定します。
同じログを複数の出力先に設定したい場合はひとつのLoggerに対して複数のAppenderを設定します。
また、異なる種類のログの出力の設定を行うために複数のLoggerとAppenderを定義することもできます。



定義概要

appender要素

appender要素では、出力するログの出力先等を設定することができます。 ログの出力には、出力先に応じたクラスを使用します。 この要素で設定可能な属性は使用するクラスにより異なります。 以下は基本的な属性です。

属性 説明
Name 定義名を定義する。
(logger要素のappender-ref要素のref属性から参照される)
Class ログ出力時に使用するクラス名を指定する。
定義例(ファイル出力の場合):ch.qos.logback.core.rolling.RollingFileAppender

RollingFileAppenderを使用した場合の記述例:

<appender name="PDFLIB_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.dir}/bspdf.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <FileNamePattern>${log.dir}/bspdf.%d{yyyy-MM-dd}.log</FileNamePattern>
    </rollingPolicy>
    <encoder>
        <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %level %logger - %msg%n%ex{full}</Pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>

logger要素

logger要素では、出力するログの種類とレベル等を設定することができます。

属性 説明
name Javaのクラス名にて、対象とするログの範囲を指定します。
Additivity 他の定義と排他的に出力するかどうかを指定します。
trueまたは未設定:排他的に出力しない(重複あり)
false:排他的に出力する(重複無し)
level value ログのレベル 下記から選択します。
OFF:ログ出力をオフにする
ERROR:エラーログのみを出力
WARN:エラー・警告ログを出力
appender-ref appender定義の名前(name)を指定します。
複数指定可能ですので、同じ内容のログを複数の出力先に出力することもできます。
【記述例】:

<logger name="com.brainsellers.pdf" additivity="true">
    <level value="WARN" />
    <appender-ref ref="PDFLIB_FILE" />
</logger>