org.apache.hadoop.chukwa.inputtools.log4j
Class ChukwaDailyRollingFileAppender

java.lang.Object
  extended by org.apache.log4j.AppenderSkeleton
      extended by org.apache.log4j.WriterAppender
          extended by org.apache.log4j.FileAppender
              extended by org.apache.hadoop.chukwa.inputtools.log4j.ChukwaDailyRollingFileAppender
All Implemented Interfaces:
org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class ChukwaDailyRollingFileAppender
extends org.apache.log4j.FileAppender

ChukwaDailyRollingFileAppender is a slightly modified version of DailyRollingFileAppender, with modified versions of its subAppend() and rollOver() functions. We would have preferred to sub-class DailyRollingFileAppender but its authors clearly did not intend that to be a viable option since they made too much of the class private or package-private DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user chosen frequency.

The rolling schedule is specified by the DatePattern option. This pattern should follow the SimpleDateFormat conventions. In particular, you must escape literal text within a pair of single quotes. A formatted version of the date pattern is used as the suffix for the rolled file name.

For example, if the File option is set to /foo/bar.log and the DatePattern set to '.'yyyy-MM-dd, on 2001-02-16 at midnight, the logging file /foo/bar.log will be copied to /foo/bar.log.2001-02-16 and logging for 2001-02-17 will continue in /foo/bar.log until it rolls over the next day.

Is is possible to specify monthly, weekly, half-daily, daily, hourly, or minutely rollover schedules.

DatePattern Rollover schedule Example
'.'yyyy-MM Rollover at the beginning of each month At midnight of May 31st, 2002 /foo/bar.log will be copied to /foo/bar.log.2002-05. Logging for the month of June will be output to /foo/bar.log until it is also rolled over the next month.
'.'yyyy-ww Rollover at the first day of each week. The first day of the week depends on the locale. Assuming the first day of the week is Sunday, on Saturday midnight, June 9th 2002, the file /foo/bar.log will be copied to /foo/bar.log.2002-23. Logging for the 24th week of 2002 will be output to /foo/bar.log until it is rolled over the next week.
'.'yyyy-MM-dd Rollover at midnight each day. At midnight, on March 8th, 2002, /foo/bar.log will be copied to /foo/bar.log.2002-03-08. Logging for the 9th day of March will be output to /foo/bar.log until it is rolled over the next day.
'.'yyyy-MM-dd-a Rollover at midnight and midday of each day. At noon, on March 9th, 2002, /foo/bar.log will be copied to /foo/bar.log.2002-03-09-AM. Logging for the afternoon of the 9th will be output to /foo/bar.log until it is rolled over at midnight.
'.'yyyy-MM-dd-HH Rollover at the top of every hour. At approximately 11:00.000 o'clock on March 9th, 2002, /foo/bar.log will be copied to /foo/bar.log.2002-03-09-10. Logging for the 11th hour of the 9th of March will be output to /foo/bar.log until it is rolled over at the beginning of the next hour.
'.'yyyy-MM-dd-HH-mm Rollover at the beginning of every minute. At approximately 11:23,000, on March 9th, 2001, /foo/bar.log will be copied to /foo/bar.log.2001-03-09-10-22. Logging for the minute of 11:23 (9th of March) will be output to /foo/bar.log until it is rolled over the next minute.

Do not use the colon ":" character in anywhere in the DatePattern option. The text before the colon is interpeted as the protocol specificaion of a URL which is probably not what you want.


Field Summary
 
Fields inherited from class org.apache.log4j.FileAppender
bufferedIO, bufferSize, fileAppend, fileName
 
Fields inherited from class org.apache.log4j.WriterAppender
encoding, immediateFlush, qw
 
Fields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
 
Constructor Summary
ChukwaDailyRollingFileAppender()
          The default constructor does nothing.
ChukwaDailyRollingFileAppender(org.apache.log4j.Layout layout, String filename, String datePattern)
          Instantiate a DailyRollingFileAppender and open the file designated by filename.
 
Method Summary
 void activateOptions()
           
protected  boolean checkEntryConditions()
          Fix for late-initialisation
protected  void cleanUp()
           
 String getChukwaClientHostname()
           
 int getChukwaClientPortNum()
           
 String getCleanUpRegex()
           
 String getDatePattern()
          Returns the value of the DatePattern option.
 int getMaxBackupIndex()
           
 String getRecordType()
           
 void setChukwaClientConnectNumRetry(int i)
           
 void setChukwaClientConnectRetryInterval(long i)
           
 void setChukwaClientHostname(String chukwaClientHostname)
           
 void setChukwaClientPortNum(int chukwaClientPortNum)
           
 void setCleanUpRegex(String cleanUpRegex)
           
 void setDatePattern(String pattern)
          The DatePattern takes a string in the same format as expected by SimpleDateFormat.
 void setMaxBackupIndex(int maxBackupIndex)
           
 void setRecordType(String recordType)
           
protected  void subAppend(org.apache.log4j.spi.LoggingEvent event)
          This method differentiates DailyRollingFileAppender from its super class.
 
Methods inherited from class org.apache.log4j.FileAppender
closeFile, getAppend, getBufferedIO, getBufferSize, getFile, reset, setAppend, setBufferedIO, setBufferSize, setFile, setFile, setQWForFiles
 
Methods inherited from class org.apache.log4j.WriterAppender
append, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, setEncoding, setErrorHandler, setImmediateFlush, setWriter, writeFooter, writeHeader
 
Methods inherited from class org.apache.log4j.AppenderSkeleton
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChukwaDailyRollingFileAppender

public ChukwaDailyRollingFileAppender()
                               throws IOException
The default constructor does nothing.

Throws:
IOException

ChukwaDailyRollingFileAppender

public ChukwaDailyRollingFileAppender(org.apache.log4j.Layout layout,
                                      String filename,
                                      String datePattern)
                               throws IOException
Instantiate a DailyRollingFileAppender and open the file designated by filename. The opened filename will become the output destination for this appender.

Throws:
IOException
Method Detail

setDatePattern

public void setDatePattern(String pattern)
The DatePattern takes a string in the same format as expected by SimpleDateFormat. This options determines the rollover schedule.


getDatePattern

public String getDatePattern()
Returns the value of the DatePattern option.


getRecordType

public String getRecordType()

setRecordType

public void setRecordType(String recordType)

activateOptions

public void activateOptions()
Specified by:
activateOptions in interface org.apache.log4j.spi.OptionHandler
Overrides:
activateOptions in class org.apache.log4j.FileAppender

getCleanUpRegex

public String getCleanUpRegex()

setCleanUpRegex

public void setCleanUpRegex(String cleanUpRegex)

getMaxBackupIndex

public int getMaxBackupIndex()

setMaxBackupIndex

public void setMaxBackupIndex(int maxBackupIndex)

cleanUp

protected void cleanUp()

checkEntryConditions

protected boolean checkEntryConditions()
Fix for late-initialisation

Overrides:
checkEntryConditions in class org.apache.log4j.WriterAppender

subAppend

protected void subAppend(org.apache.log4j.spi.LoggingEvent event)
This method differentiates DailyRollingFileAppender from its super class.

Before actually logging, this method will check whether it is time to do a rollover. If it is, it will schedule the next rollover time and then rollover.

Overrides:
subAppend in class org.apache.log4j.WriterAppender

getChukwaClientHostname

public String getChukwaClientHostname()

setChukwaClientHostname

public void setChukwaClientHostname(String chukwaClientHostname)

getChukwaClientPortNum

public int getChukwaClientPortNum()

setChukwaClientPortNum

public void setChukwaClientPortNum(int chukwaClientPortNum)

setChukwaClientConnectNumRetry

public void setChukwaClientConnectNumRetry(int i)

setChukwaClientConnectRetryInterval

public void setChukwaClientConnectRetryInterval(long i)


Copyright © ${year} The Apache Software Foundation