Java/Logging/ApacheLog4j2/Appenders の履歴(No.8)

• 履歴一覧
• ソース を表示
• Java/Logging/ApacheLog4j2/Appenders は削除されています。
  • 1 (2018-03-30 (金) 22:41:46)
  • 2 (2018-03-30 (金) 22:53:49)
  • 3 (2018-03-31 (土) 13:34:44)
  • 4 (2018-03-31 (土) 19:35:05)
  • 5 (2018-04-01 (日) 21:36:28)
  • 6 (2018-04-07 (土) 14:47:35)
  • 7 (2018-08-28 (火) 23:42:52)
  • 8 (2021-06-23 (水) 17:42:56)
  • 9 (2021-06-23 (水) 17:43:14)

---

Java/Logging/ApacheLog4j2

Appenders†

RollingFileAppender†

RollingFileAppenderは、fileNameパラメータで指定されたFileに書き込み、TriggeringPolicyおよびRolloverPolicyに従ってファイルをロールオーバーするOutputStreamAppenderです。 RollingFileAppenderは、実際にファイルI / Oを実行してロールオーバーを実行するために、OutputStreamManagerを拡張するRollingFileManagerを使用します。 異なる構成からのRolloverFileAppendersは共有できませんが、マネージャにアクセス可能であれば、RollingFileManagersを使用できます。 たとえば、サーブレットコンテナ内の2つのWebアプリケーションは、Log4jが両方に共通のClassLoaderにある場合、独自の構成を持ち、同じファイルに安全に書き込むことができます。

RollingFileAppenderは必要ですTriggeringPolicyとRolloverStrategyを。 トリガポリシーは、ロールオーバーを実行するかどうかを決定しますが、ロールオーバストラテジはロールオーバーの実行方法を定義します。 RolloverStrategyが設定されていない場合、RollingFileAppenderはDefaultRolloStrategyを使用します。 log4j-2.5以降、ロールオーバー時に実行するDefaultRolloStrategyのカスタム削除アクションを設定できます。 ファイル名が設定されていない場合は2.8であるため、DefaultRolloStrategyの代わりにDirectWriteRolloStrategyが使用されます。 log4j-2.9以降、カスタムPOSIXファイル属性ビューアクションは、ロールオーバー時に実行するようにDefaultRolloStrategyで設定できます。 定義されていない場合は、RollingFileAppenderの継承POSIXファイル属性ビューが適用されます。

ファイルのロックは、RollingFileAppenderによってサポートされていません。

Triggering Policies†

Composite Triggering Policy†

CompositeTriggeringPolicyは複数のトリガーポリシーを組み合わせ、設定されたポリシーのいずれかがtrueを返す場合はtrueを返します。 CompositeTriggeringPolicyは、ポリシー要素に他のポリシーをラップするだけで構成されます。 たとえば、次のXMLフラグメントは、JVMの起動時、ログサイズが20メガバイトに達したとき、 および現在の日付がログの開始日と一致しなくなったときに、ログをロールオーバーするポリシーを定義します。

<Policies>
  <OnStartupTriggeringPolicy />
  <SizeBasedTriggeringPolicy size = "20 MB" />
  <TimeBasedTriggeringPolicy />
</ Policies> 

Cron Triggering Policy†

CronTriggeringPolicy は、cron expression に基づいてロールオーバーをトリガーします。

OnStartup Triggering Policy†

OnStartupTriggeringPolicy ポリシーは、ログファイルが現在のJVMの開始時刻より古いもので、最小ファイルサイズが満たされているか超過している場合にロールオーバーを引き起こします。

Google App Engine note: Google App Engineで実行しているとき、Log4Jが初期化された時間より古いログファイルの場合、OnStartupポリシーはロールオーバーを引き起こします 。 （Google App Engineは特定のクラスへのアクセスを制限して、Log4Jは

java.lang.management.ManagementFactory.getRuntimeMXBean().getStartTime()

を使用して JVM の開始時刻を判断できず、代わりに Log4J の初期化時刻に戻ります。

SizeBased Triggering Policy†

SizeBasedTriggeringPolicy は、ファイルが指定されたサイズに達するとロールオーバーを引き起こします。 サイズはバイト単位で指定できます。接尾辞はKB、MBまたはGBです（例： 20MB）

TimeBased Triggering Policy†

TimeBasedTriggeringPolicyは、日付/時刻パターンがアクティブなファイルに適用されなくなるとロールオーバーを引き起こします。 このポリシーは、ロールオーバーが時間パターンとブール値の変調属性に基づいて発生する頻度を示す間隔属性を受け入れます。

Rollover Strategies†

Default Rollover Strategy†

デフォルトのロールオーバー戦略では、RollingFileAppender自体で指定されたfilePattern属性の日付/時刻パターンと整数の両方を使用できます。 日付/時刻パターンが存在する場合は、現在の日付と時刻の値に置き換えられます。 パターンに整数が含まれている場合は、ロールオーバーごとにインクリメントされます。 パターンに日付/時刻と整数の両方が含まれている場合、整数は日付/時刻パターンの結果が変わるまで増分されます。 ファイルパターンが ".gz"、 ".zip"、 ".bz2"、 ".deflate"、 ".pack200"、または ".xz"で終わる場合、 結果のアーカイブはサフィックスに一致する圧縮スキームを使用して圧縮されます。 bzip2、Deflate、Pack200、XZの形式ではApache Commons Compressが必要です。 さらに、XZにはXZ for Javaが必要です。 このパターンには、以下の例に示すように、実行時に解決できるルックアップ参照も含まれている場合があります。

デフォルトのロールオーバー戦略は、カウンタをインクリメントするための3つのバリエーションをサポートしています。 1つは「固定ウィンドウ」戦略です。 どのように動作するかを説明するために、min属性が1に設定され、max属性が3に設定され、 ファイル名が "foo.log"であり、ファイル名パターンが "foo-％i.log"であるとします。

対照的に、fileIndex属性が "max"に設定されているが、他のすべての設定が同じ場合、次のアクションが実行されます。

最後に、2.8より、fileIndex 属性が "nomax"に設定されている場合、最小値と最大値は無視され、ファイル番号は1ずつ増加し、各ロールオーバーはファイルの最大数なしで段階的に高い値を持ちます。

DirectWrite Rollover Strategy†

DirectWriteRolloverStrategyは、ログイベントをファイルパターンが表すファイルに直接書き込むようにします。 この戦略では、ファイルの名前変更は実行されません。 サイズベースのトリガーポリシーによって、複数のファイルが指定された期間内に書き込まれる場合、 番号は1から始まり、時間ベースのロールオーバーが発生するまで継続的に増分されます。 警告：ファイルパターンの末尾に圧縮があることが示されている場合は、アプリケーションがシャットダウンされても現在のファイルは圧縮されません。 さらに、ファイルパターンが現在のファイルと一致しなくなるように時間が変更された場合、起動時に圧縮されません。

以下は、RollingFileAppenderを使用して時間とサイズに基づいたトリガーポリシーを使用するサンプル構成で、 現在の年と月に基づいてディレクトリに格納されている同じ日（1-7）に最大7個のアーカイブを作成し、 gzipを使って各アーカイブを圧縮する：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <TimeBasedTriggeringPolicy />
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

この2番目の例では、削除する前に最大20のファイルを保持するロールオーバー戦略を示しています。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <TimeBasedTriggeringPolicy />
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
      <DefaultRolloverStrategy max="20"/>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

以下は、RollingFileAppenderを使用して時間とサイズに基づいたトリガーポリシーを使用するサンプル構成で、 現在の年と月に基づいてディレクトリに格納されている同じ日（1-7）に最大7個のアーカイブを作成し、 gzipを使用して各アーカイブを圧縮し、時間が6で割り切れる場合は6時間ごとにロールバックします：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/$${date:yyyy-MM}/app-%d{yyyy-MM-dd-HH}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <TimeBasedTriggeringPolicy interval="6" modulate="true"/>
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

このサンプル構成では、cron およびサイズベースのトリガーポリシーの両方を使用する RollingFileAppender を使用し、 無制限のアーカイブファイルに直接書き込みます。 ファイルサイズが250MBに制限されている間、cronトリガーは1時間にロールオーバーを引き起こします。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <RollingFile name="RollingFile" filePattern="logs/app-%d{yyyy-MM-dd-HH}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <CronTriggeringPolicy schedule="0 0 * * * ?"/>
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

この設定例は前と同じですが、1時間ごとに保存されるファイル数を10に制限しています。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <RollingFile name="RollingFile" filePattern="logs/app-%d{yyyy-MM-dd-HH}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <CronTriggeringPolicy schedule="0 0 * * * ?"/>
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
      <DirectWriteRolloverStrategy maxFiles="10"/>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

Log Archive Retention Policy: Delete on Rollover†

Log4j-2.5にはDeleteアクションが導入されており、ユーザーはロールオーバー時にDefaultRolloStrategy max属性で可能だったファイルよりも削除されるファイルをより詳細に制御できます。 削除アクションを使用すると、ベースディレクトリに対して削除するファイルを選択する1つまたは複数の条件を設定できます。 ロールオーバーされたログファイルだけでなく、すべてのファイルを削除することができるので、注意してこのアクションを使用してください。 testModeパラメータを使用すると、誤って間違ったファイルを削除することなく構成をテストできます。

以下は、RollingFileAppenderを使用してcronトリガーポリシーを使用して、深夜0時にトリガーするサンプル構成です。 アーカイブは、現在の年と月に基づいてディレクトリに格納されます。 "*/app-*.log.gz" グロブと一致し、60日以上経過したベースディレクトリの下にあるすべてのファイルは、ロールオーバー時に削除されます。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Properties>
    <Property name="baseDir">logs</Property>
  </Properties>
  <Appenders>
    <RollingFile name="RollingFile" fileName="${baseDir}/app.log"
          filePattern="${baseDir}/$${date:yyyy-MM}/app-%d{yyyy-MM-dd}.log.gz">
      <PatternLayout pattern="%d %p %c{1.} [%t] %m%n" />
      <CronTriggeringPolicy schedule="0 0 0 * * ?"/>
      <DefaultRolloverStrategy>
        <Delete basePath="${baseDir}" maxDepth="2">
          <IfFileName glob="*/app-*.log.gz" />
          <IfLastModified age="60d" />
        </Delete>
      </DefaultRolloverStrategy>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

以下は、RollingFileAppenderを使用して時間とサイズに基づいたトリガーポリシーを使用するサンプル構成です。 現在の年と月に基づいてディレクトリに格納されている同じ日（1-100）のアーカイブを最大100個作成します。 gzipを使って各アーカイブを圧縮し、1時間ごとにロールバックします。 すべてのロールオーバの間、この設定では、"*/app-*.log.gz" に一致する30日以上のファイルが削除されますが、 最新の100 GBまたは最新の10ファイルのいずれか早い方を保持します。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Properties>
    <Property name="baseDir">logs</Property>
  </Properties>
  <Appenders>
    <RollingFile name="RollingFile" fileName="${baseDir}/app.log"
          filePattern="${baseDir}/$${date:yyyy-MM}/app-%d{yyyy-MM-dd-HH}-%i.log.gz">
      <PatternLayout pattern="%d %p %c{1.} [%t] %m%n" />
      <Policies>
        <TimeBasedTriggeringPolicy />
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
      <DefaultRolloverStrategy max="100">
        <!--
        Nested conditions: the inner condition is only evaluated on files
        for which the outer conditions are true.
        -->
        <Delete basePath="${baseDir}" maxDepth="2">
          <IfFileName glob="*/app-*.log.gz">
            <IfLastModified age="30d">
              <IfAny>
                <IfAccumulatedFileSize exceeds="100 GB" />
                <IfAccumulatedFileCount exceeds="10" />
              </IfAny>
            </IfLastModified>
          </IfFileName>
        </Delete>
      </DefaultRolloverStrategy>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

以下は、RollingFileAppenderを使用してcronトリガーポリシーを使用して、深夜0時にトリガーするサンプル構成です。 アーカイブは、現在の年と月に基づいてディレクトリに格納されます。 スクリプトは、13日金曜日のベースディレクトリの下にロールオーバーされたファイルのリストを返します。 削除アクションは、スクリプトによって返されたすべてのファイルを削除します。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="trace" name="MyApp" packages="">
  <Properties>
    <Property name="baseDir">logs</Property>
  </Properties>
  <Appenders>
    <RollingFile name="RollingFile" fileName="${baseDir}/app.log"
          filePattern="${baseDir}/$${date:yyyy-MM}/app-%d{yyyyMMdd}.log.gz">
      <PatternLayout pattern="%d %p %c{1.} [%t] %m%n" />
      <CronTriggeringPolicy schedule="0 0 0 * * ?"/>
      <DefaultRolloverStrategy>
        <Delete basePath="${baseDir}" maxDepth="2">
          <ScriptCondition>
            <Script name="superstitious" language="groovy"><![CDATA[
                import java.nio.file.*;
 
                def result = [];
                def pattern = ~/\d*\/app-(\d*)\.log\.gz/;
 
                pathList.each { pathWithAttributes ->
                  def relative = basePath.relativize pathWithAttributes.path
                  statusLogger.trace 'SCRIPT: relative path=' + relative + " (base=$basePath)";
 
                  // remove files dated Friday the 13th
 
                  def matcher = pattern.matcher(relative.toString());
                  if (matcher.find()) {
                    def dateString = matcher.group(1);
                    def calendar = Date.parse("yyyyMMdd", dateString).toCalendar();
                    def friday13th = calendar.get(Calendar.DAY_OF_MONTH) == 13 \
                                  && calendar.get(Calendar.DAY_OF_WEEK) == Calendar.FRIDAY;
                    if (friday13th) {
                      result.add pathWithAttributes;
                      statusLogger.trace 'SCRIPT: deleting path ' + pathWithAttributes;
                    }
                  }
                }
                statusLogger.trace 'SCRIPT: returning ' + result;
                result;
              ]] >
            </Script>
          </ScriptCondition>
        </Delete>
      </DefaultRolloverStrategy>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

Log Archive File Attribute View Policy: Custom file attribute on Rollover†

Log4j-2.9にはPosixViewAttributeアクションが導入されており、ユーザにどのファイル属性パーミッション、所有者およびグループを適用すべきかをより詳細に制御できます。 PosixViewAttributeアクションを使用すると、ベースディレクトリに対して適切なファイルを選択する条件を1つ以上設定できます。

以下は、RollingFileAppenderを使用し、現在のログファイルとロールログファイルに対して異なるPOSIXファイル属性ビューを定義するサンプル構成です。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="trace" name="MyApp" packages="">
  <Properties>
    <Property name="baseDir">logs</Property>
  </Properties>
  <Appenders>
    <RollingFile name="RollingFile" fileName="${baseDir}/app.log"
          		 filePattern="${baseDir}/$${date:yyyy-MM}/app-%d{yyyyMMdd}.log.gz"
                 filePermissions="rw-------">
      <PatternLayout pattern="%d %p %c{1.} [%t] %m%n" />
      <CronTriggeringPolicy schedule="0 0 0 * * ?"/>
      <DefaultRolloverStrategy stopCustomActionsOnError="true">
        <PosixViewAttribute basePath="${baseDir}/$${date:yyyy-MM}" filePermissions="r--r--r--">
        	<IfFileName glob="*.gz" />
        </PosixViewAttribute>
      </DefaultRolloverStrategy>
    </RollingFile>
  </Appenders>
 
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
 
</Configuration>