Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Class Members | Related Pages

DailyRollingFileAppender Class Reference

Inheritance diagram for DailyRollingFileAppender:

Inheritance graph
[legend]
Collaboration diagram for DailyRollingFileAppender:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DailyRollingFileAppender ()
 DailyRollingFileAppender (LayoutPtr &layout, const String &filename, const String &datePattern)
void setDatePattern (const String &pattern)
const String & getDatePattern () const
void activateOptions ()
void setOption (const String &option, const String &value)

Protected Member Functions

void rollOver ()
virtual void subAppend (const spi::LoggingEventPtr &event)

Protected Attributes

String datePattern
String scheduledFilename
int64_t nextCheck

Detailed Description

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 helpers::DateFormat 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 00:00 AM March 8th, 2002, /foo/bar.log will be copied to /foo/bar.log.2002-03-07. Logging for the 8th 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-11-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.

Constructor & Destructor Documentation

DailyRollingFileAppender (   ) 
 

The default constructor does nothing.

DailyRollingFileAppender (  LayoutPtr &  layout,
const String &  filename,
const String &  datePattern
) 
 

Instantiate a DailyRollingFileAppender and open the file designated by filename. The opened filename will become the ouput destination for this appender.

Member Function Documentation

void activateOptions (   )  [virtual]
 

Sets and opens the file where the log output will go. The specified file must be writable.

If there was already an opened file, then the previous file is closed first.

Reimplemented from FileAppender.

const String& getDatePattern (   )  const [inline]
 

Returns the value of the DatePattern option.

void rollOver (   )  [protected]
 

Rollover the current file to a new file.

void setDatePattern (  const String &  pattern  )  [inline]
 

The DatePattern takes a string in the same format as expected by helpers::DateFormat. This options determines the rollover schedule.

void setOption (  const String &  option,
const String &  value
)  [virtual]
 

Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.

Reimplemented from FileAppender.

void subAppend (  const spi::LoggingEventPtr &  event  )  [protected, virtual]
 

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.

Reimplemented from WriterAppender.

Member Data Documentation

String datePattern [protected]
 

The date pattern. By default, the pattern is set to "'.'yyyy-MM-dd" meaning daily rollover.

int64_t nextCheck [protected]
 

The next time we estimate a rollover should occur.

String scheduledFilename [protected]
 

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.

The documentation for this class was generated from the following files:
  • dailyrollingfileappender.h
  • dailyrollingfileappender.cpp
Copyright © 1999-2004, Apache Software Foundation