Apache log4cxx  Version 0.12.0
log4cxx::rolling::TimeBasedRollingPolicy Class Reference

TimeBasedRollingPolicy is both easy to configure and quite powerful. More...

#include <timebasedrollingpolicy.h>

Inheritance diagram for log4cxx::rolling::TimeBasedRollingPolicy:
log4cxx::rolling::RollingPolicyBase log4cxx::rolling::TriggeringPolicy log4cxx::rolling::RollingPolicy log4cxx::helpers::Object log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::helpers::Object

Public Member Functions

 TimeBasedRollingPolicy ()
 
void activateOptions (log4cxx::helpers::Pool &)
 Activate the options that were previously set with calls to option setters. More...
 
RolloverDescriptionPtr initialize (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)
 Initialize the policy and return any initial actions for rolling file appender.
Parameters
currentActiveFilecurrent value of RollingFileAppender.getFile().
appendcurrent value of RollingFileAppender.getAppend().
poolpool for memory allocations during call.
Returns
Description of the initialization, may be null to indicate no initialization needed.
Exceptions
SecurityExceptionif denied access to log files.
More...
 
RolloverDescriptionPtr rollover (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)
 Prepare for a rollover.This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.
Parameters
currentActiveFilefile name for current active log file.
appendcurrent value of the parent FileAppender.getAppend().
poolpool for memory allocations during call.
Returns
Description of pending rollover, may be null to indicate no rollover at this time.
Exceptions
SecurityExceptionif denied access to log files.
More...
 
virtual bool isTriggeringEvent (Appender *appender, const log4cxx::spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)
 Determines if a rollover may be appropriate at this time. More...
 
- Public Member Functions inherited from log4cxx::rolling::RollingPolicyBase
 RollingPolicyBase ()
 
virtual ~RollingPolicyBase ()
 
virtual void setOption (const LogString &option, const LogString &value)
 Set option to value. More...
 
void setFileNamePattern (const LogString &fnp)
 Set file name pattern. More...
 
LogString getFileNamePattern () const
 Get file name pattern. More...
 
- Public Member Functions inherited from log4cxx::rolling::RollingPolicy
virtual ~RollingPolicy ()
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 
- Public Member Functions inherited from log4cxx::rolling::TriggeringPolicy
virtual ~TriggeringPolicy ()
 

Protected Member Functions

log4cxx::pattern::PatternMap getFormatSpecifiers () const
 
- Protected Member Functions inherited from log4cxx::rolling::RollingPolicyBase
void parseFileNamePattern ()
 Parse file name pattern. More...
 
void formatFileName (log4cxx::helpers::ObjectPtr &obj, LogString &buf, log4cxx::helpers::Pool &p) const
 Format file name. More...
 
log4cxx::pattern::PatternConverterPtr getIntegerPatternConverter () const
 
log4cxx::pattern::PatternConverterPtr getDatePatternConverter () const
 

Detailed Description

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 log4cxx::helpers::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 activateOptions method before using this policy. Moreover, activateOptions of TimeBasedRollingPolicy must be called before calling the activateOptions method of the owning RollingFileAppender.

Constructor & Destructor Documentation

◆ TimeBasedRollingPolicy()

log4cxx::rolling::TimeBasedRollingPolicy::TimeBasedRollingPolicy ( )

Member Function Documentation

◆ activateOptions()

void log4cxx::rolling::TimeBasedRollingPolicy::activateOptions ( log4cxx::helpers::Pool p)
virtual

Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

Implements log4cxx::rolling::RollingPolicyBase.

◆ getFormatSpecifiers()

log4cxx::pattern::PatternMap log4cxx::rolling::TimeBasedRollingPolicy::getFormatSpecifiers ( ) const
protectedvirtual

◆ initialize()

RolloverDescriptionPtr log4cxx::rolling::TimeBasedRollingPolicy::initialize ( const LogString currentActiveFile,
const bool  append,
log4cxx::helpers::Pool pool 
)
virtual

Initialize the policy and return any initial actions for rolling file appender.

Parameters
currentActiveFilecurrent value of RollingFileAppender.getFile().
appendcurrent value of RollingFileAppender.getAppend().
poolpool for memory allocations during call.
Returns
Description of the initialization, may be null to indicate no initialization needed.
Exceptions
SecurityExceptionif denied access to log files.

Implements log4cxx::rolling::RollingPolicy.

◆ isTriggeringEvent()

virtual bool log4cxx::rolling::TimeBasedRollingPolicy::isTriggeringEvent ( Appender appender,
const log4cxx::spi::LoggingEventPtr event,
const LogString filename,
size_t  fileLength 
)
virtual

Determines if a rollover may be appropriate at this time.

If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.

Parameters
appenderA reference to the appender.
eventA reference to the currently event.
filenameThe filename for the currently active log file.
fileLengthLength of the file in bytes.
Returns
true if a rollover should occur.

Implements log4cxx::rolling::TriggeringPolicy.

◆ rollover()

RolloverDescriptionPtr log4cxx::rolling::TimeBasedRollingPolicy::rollover ( const LogString currentActiveFile,
const bool  append,
log4cxx::helpers::Pool pool 
)
virtual

Prepare for a rollover.This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.

Parameters
currentActiveFilefile name for current active log file.
appendcurrent value of the parent FileAppender.getAppend().
poolpool for memory allocations during call.
Returns
Description of pending rollover, may be null to indicate no rollover at this time.
Exceptions
SecurityExceptionif denied access to log files.

Implements log4cxx::rolling::RollingPolicy.


The documentation for this class was generated from the following file: