Class DailyRollingFileAppender
- java.lang.Object
-
- org.apache.log4j.AppenderSkeleton
-
- org.apache.log4j.WriterAppender
-
- org.apache.log4j.FileAppender
-
- org.apache.log4j.DailyRollingFileAppender
-
- All Implemented Interfaces:
Appender
,OptionHandler
public class DailyRollingFileAppender extends FileAppender
DailyRollingFileAppender extendsFileAppender
so that the underlying file is rolled over at a user chosen frequency. DailyRollingFileAppender has been observed to exhibit synchronization issues and data loss. The log4j extras companion includes alternatives which should be considered for new deployments and which are discussed in the documentation for org.apache.log4j.rolling.RollingFileAppender.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 Modifier and Type Field Description (package private) int
checkPeriod
private java.lang.String
datePattern
The date pattern.(package private) static java.util.TimeZone
gmtTimeZone
(package private) static int
HALF_DAY
private long
nextCheck
The next time we estimate a rollover should occur.(package private) java.util.Date
now
(package private) RollingCalendar
rc
private java.lang.String
scheduledFilename
The log file will be renamed to the value of the scheduledFilename variable when the next interval is entered.(package private) java.text.SimpleDateFormat
sdf
(package private) static int
TOP_OF_DAY
(package private) static int
TOP_OF_HOUR
(package private) static int
TOP_OF_MINUTE
(package private) static int
TOP_OF_MONTH
(package private) static int
TOP_OF_TROUBLE
(package private) static int
TOP_OF_WEEK
-
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
Constructors Constructor Description DailyRollingFileAppender()
The default constructor does nothing.DailyRollingFileAppender(Layout layout, java.lang.String filename, java.lang.String datePattern)
Instantiate aDailyRollingFileAppender
and open the file designated byfilename
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activateOptions()
If the value of File is notnull
, thenFileAppender.setFile(java.lang.String)
is called with the values of File and Append properties.(package private) int
computeCheckPeriod()
java.lang.String
getDatePattern()
Returns the value of the DatePattern option.(package private) void
printPeriodicity(int type)
(package private) void
rollOver()
Rollover the current file to a new file.void
setDatePattern(java.lang.String pattern)
The DatePattern takes a string in the same format as expected bySimpleDateFormat
.protected void
subAppend(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, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, writeFooter, writeHeader
-
Methods inherited from class org.apache.log4j.AppenderSkeleton
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold
-
-
-
-
Field Detail
-
TOP_OF_TROUBLE
static final int TOP_OF_TROUBLE
- See Also:
- Constant Field Values
-
TOP_OF_MINUTE
static final int TOP_OF_MINUTE
- See Also:
- Constant Field Values
-
TOP_OF_HOUR
static final int TOP_OF_HOUR
- See Also:
- Constant Field Values
-
HALF_DAY
static final int HALF_DAY
- See Also:
- Constant Field Values
-
TOP_OF_DAY
static final int TOP_OF_DAY
- See Also:
- Constant Field Values
-
TOP_OF_WEEK
static final int TOP_OF_WEEK
- See Also:
- Constant Field Values
-
TOP_OF_MONTH
static final int TOP_OF_MONTH
- See Also:
- Constant Field Values
-
datePattern
private java.lang.String datePattern
The date pattern. By default, the pattern is set to "'.'yyyy-MM-dd" meaning daily rollover.
-
scheduledFilename
private java.lang.String scheduledFilename
The log file will be renamed to the value of the scheduledFilename variable when the next interval is entered. For example, if the rollover period is one hour, the log file will be renamed to the value of "scheduledFilename" at the beginning of the next hour. The precise time when a rollover occurs depends on logging activity.
-
nextCheck
private long nextCheck
The next time we estimate a rollover should occur.
-
now
java.util.Date now
-
sdf
java.text.SimpleDateFormat sdf
-
rc
RollingCalendar rc
-
checkPeriod
int checkPeriod
-
gmtTimeZone
static final java.util.TimeZone gmtTimeZone
-
-
Constructor Detail
-
DailyRollingFileAppender
public DailyRollingFileAppender()
The default constructor does nothing.
-
DailyRollingFileAppender
public DailyRollingFileAppender(Layout layout, java.lang.String filename, java.lang.String datePattern) throws java.io.IOException
Instantiate aDailyRollingFileAppender
and open the file designated byfilename
. The opened filename will become the ouput destination for this appender.- Throws:
java.io.IOException
-
-
Method Detail
-
setDatePattern
public void setDatePattern(java.lang.String pattern)
The DatePattern takes a string in the same format as expected bySimpleDateFormat
. This options determines the rollover schedule.
-
getDatePattern
public java.lang.String getDatePattern()
Returns the value of the DatePattern option.
-
activateOptions
public void activateOptions()
Description copied from class:FileAppender
If the value of File is notnull
, thenFileAppender.setFile(java.lang.String)
is called with the values of File and Append properties.- Specified by:
activateOptions
in interfaceOptionHandler
- Overrides:
activateOptions
in classFileAppender
-
printPeriodicity
void printPeriodicity(int type)
-
computeCheckPeriod
int computeCheckPeriod()
-
rollOver
void rollOver() throws java.io.IOException
Rollover the current file to a new file.- Throws:
java.io.IOException
-
subAppend
protected void subAppend(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 classWriterAppender
-
-