Examples of org.apache.log4j.rolling.TimeBasedRollingPolicy

org.apache.log4j.rolling.TimeBasedRollingPolicy

TimeBasedRollingPolicy is both easy to configure and quite powerful.

In order to use TimeBasedRollingPolicy, the FileNamePattern option must be set. It basically specifies the name of the rolled log files. The value FileNamePattern should consist of the name of the file, plus a suitably placed %d conversion specifier. The %d conversion specifier may contain a date and time pattern as specified by the {@link java.text.SimpleDateFormat} class. If the date and time pattern is ommitted, then the default pattern of "yyyy-MM-dd" is assumed. The following examples should clarify the point.

`FileNamePattern` value	Rollover schedule	Example
`/wombat/folder/foo.%d`	Daily rollover (at midnight). Due to the omission of the optional time and date pattern for the %d token specifier, the default pattern of "yyyy-MM-dd" is assumed, which corresponds to daily rollover.	During November 23rd, 2004, logging output will go to the file `/wombat/foo.2004-11-23`. At midnight and for the rest of the 24th, logging output will be directed to `/wombat/foo.2004-11-24`.
`/wombat/foo.%d{yyyy-MM}.log`	Rollover at the beginning of each month.	During the month of October 2004, logging output will go to `/wombat/foo.2004-10.log`. After midnight of October 31st and for the rest of November, logging output will be directed to `/wombat/foo.2004-11.log`.

Automatic file compression

TimeBasedRollingPolicy supports automatic file compression. This feature is enabled if the value of the FileNamePattern option ends with .gz or .zip.

`FileNamePattern` value	Rollover schedule	Example
`/wombat/foo.%d.gz`	Daily rollover (at midnight) with automatic GZIP compression of the arcived files.	During November 23rd, 2004, logging output will go to the file `/wombat/foo.2004-11-23`. However, at midnight that file will be compressed to become `/wombat/foo.2004-11-23.gz`. For the 24th of November, logging output will be directed to `/wombat/folder/foo.2004-11-24` until its rolled over at the beginning of the next day.

Decoupling the location of the active log file and the archived log files

The active file is defined as the log file for the current period whereas archived files are thos files which have been rolled over in previous periods.

By setting the ActiveFileName option you can decouple the location of the active log file and the location of the archived log files.

`FileNamePattern` value	ActiveFileName	Rollover schedule	Example
`/wombat/foo.log.%d`	`/wombat/foo.log`	Daily rollover.	During November 23rd, 2004, logging output will go to the file `/wombat/foo.log`. However, at midnight that file will archived as `/wombat/foo.log.2004-11-23`. For the 24th of November, logging output will be directed to `/wombat/folder/foo.log` until its archived as `/wombat/foo.log.2004-11-24` at the beginning of the next day.

If configuring programatically, do not forget to call {@link #activateOptions}method before using this policy. Moreover, {@link #activateOptions} of TimeBasedRollingPolicy must be called before calling the {@link #activateOptions} method of the owningRollingFileAppender. @author Ceki Gülcü @since 1.3


  /**
   * Prepares DailyRollingFileAppender for use.
   */
  public void activateOptions() {
    TimeBasedRollingPolicy policy = new TimeBasedRollingPolicy();
    StringBuffer pattern = new StringBuffer(rfa.getFile());
    boolean inLiteral = false;
    boolean inPattern = false;


    for (int i = 0; i < datePattern.length(); i++) {
      if (datePattern.charAt(i) == '\'') {
        inLiteral = !inLiteral;


        if (inLiteral && inPattern) {
          pattern.append("}");
          inPattern = false;
        }
      } else {
        if (!inLiteral && !inPattern) {
          pattern.append("%d{");
          inPattern = true;
        }


        pattern.append(datePattern.charAt(i));
      }
    }


    if (inPattern) {
      pattern.append("}");
    }


    policy.setFileNamePattern(pattern.toString());
    policy.activateOptions();
    rfa.setTriggeringPolicy(policy);
    rfa.setRollingPolicy(policy);


    rfa.activateOptions();
  }

View Full Code Here

    {
      Logger rootLogger = Logger.getRootLogger();
      
      rootLogger.setLevel(Level.INFO);


      TimeBasedRollingPolicy rollingPolicy = new TimeBasedRollingPolicy();
      File logDir = new File(gs.getAtlasDir(), "logs");
      rollingPolicy.setFileNamePattern(logDir.getAbsolutePath()+"/nunaliit.%d.gz");
      rollingPolicy.activateOptions();
      
      RollingFileAppender fileAppender = new RollingFileAppender();
      fileAppender.setRollingPolicy(rollingPolicy);
      fileAppender.setTriggeringPolicy(rollingPolicy);
      fileAppender.setLayout(new PatternLayout("%d{ISO8601}[%-5p]: %m%n"));

View Full Code Here

    filter.setLevelMax(Level.INFO);
    filter.setLevelMin(Level.INFO);
    filter.setAcceptOnMatch(true);
    filter.activateOptions();


    TimeBasedRollingPolicy statusesRollingPolicy = new TimeBasedRollingPolicy();
    statusesRollingPolicy.setFileNamePattern("statuses.log" + HOUR_ROLL);
    statusesRollingPolicy.activateOptions();


    RollingFileAppender statusesAppender = new RollingFileAppender();
    statusesAppender.setRollingPolicy(statusesRollingPolicy);
    statusesAppender.addFilter(filter);
    statusesAppender.setLayout(layoutSimple);
    statusesAppender.activateOptions();


    TimeBasedRollingPolicy warningsRollingPolicy = new TimeBasedRollingPolicy();
    warningsRollingPolicy.setFileNamePattern("warnings.log" + HOUR_ROLL);
    warningsRollingPolicy.activateOptions();


    RollingFileAppender warningsAppender = new RollingFileAppender();
    warningsAppender.setRollingPolicy(statusesRollingPolicy);
    warningsAppender.setThreshold(Level.WARN);
    warningsAppender.setLayout(layoutStandard);

View Full Code Here

    filter.setLevelMax(Level.INFO);
    filter.setLevelMin(Level.INFO);
    filter.setAcceptOnMatch(true);
    filter.activateOptions();


    TimeBasedRollingPolicy statusesRollingPolicy = new TimeBasedRollingPolicy();
    statusesRollingPolicy.setFileNamePattern("statuses.log" + HOUR_ROLL);
    statusesRollingPolicy.activateOptions();


    RollingFileAppender statusesAppender = new RollingFileAppender();
    statusesAppender.setRollingPolicy(statusesRollingPolicy);
    statusesAppender.addFilter(filter);
    statusesAppender.setLayout(layoutSimple);
    statusesAppender.activateOptions();


    TimeBasedRollingPolicy warningsRollingPolicy = new TimeBasedRollingPolicy();
    warningsRollingPolicy.setFileNamePattern("warnings.log" + HOUR_ROLL);
    warningsRollingPolicy.activateOptions();


    RollingFileAppender warningsAppender = new RollingFileAppender();
    warningsAppender.setRollingPolicy(statusesRollingPolicy);
    warningsAppender.setThreshold(Level.WARN);
    warningsAppender.setLayout(layoutStandard);

View Full Code Here

    {
      Logger rootLogger = Logger.getRootLogger();
      
      rootLogger.setLevel(Level.INFO);


      TimeBasedRollingPolicy rollingPolicy = new TimeBasedRollingPolicy();
      File logDir = new File(gs.getAtlasDir(), "logs");
      rollingPolicy.setFileNamePattern(logDir.getAbsolutePath()+"/nunaliit.%d.gz");
      rollingPolicy.activateOptions();
      
      RollingFileAppender fileAppender = new RollingFileAppender();
      fileAppender.setRollingPolicy(rollingPolicy);
      fileAppender.setTriggeringPolicy(rollingPolicy);
      fileAppender.setLayout(new PatternLayout("%d{ISO8601}[%-5p]: %m%n"));

View Full Code Here

0 1

TOP

Related Classes of org.apache.log4j.rolling.TimeBasedRollingPolicy

ca.carleton.gcrc.couch.command.CommandRun

cc.twittertools.stream.GatherStatusStream

org.apache.log4j.DailyRollingFileAppender

org.apache.log4j.multiplex.AppenderFactoryUtils

org.apache.log4j.pattern.PatternConverter

org.apache.log4j.rolling.helper.Action

org.apache.log4j.rolling.helper.DateTokenConverter

org.apache.log4j.rolling.helper.FileNamePattern

org.apache.log4j.rolling.helper.FileRenameAction

org.apache.log4j.rolling.helper.GZCompressAction

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.