Qore Logger Module Reference  0.2
Logger::LoggerAppenderFileRotate Class Reference

Implements appender writing to a file with file rotation support. More...

Inheritance diagram for Logger::LoggerAppenderFileRotate:

Public Member Methods

 constructor (*string name, LoggerLayout layout, string filename, int count=DEFAULT_ROTATION_COUNT, string archive=DEFAULT_ARCHIVE_PATTERN, *string encoding)
 Creates the object. More...
 
string getArchiveFileName (int idx)
 Returns the archive filename. More...
 
int getCount ()
 Returns max.number of files in chain.
 
 processEventImpl (int type, auto params)
 Implements filename rotation; handles the open and rotate events directly; passes all other events to the subclass for handling. More...
 
- Public Member Methods inherited from Logger::AbstractLoggerAppenderFileRotate
 rotate ()
 Pushes rotate event. More...
 
- Public Member Methods inherited from Logger::LoggerAppenderFile
 constructor (*string name, LoggerLayout layout, string filename, *string encoding)
 Creates the object. More...
 
File getFile ()
 Returns the file object for the appender.
 
string getFileName ()
 Returns the current filename.
 
- Public Member Methods inherited from Logger::LoggerAppenderWithLayout
 constructor (*string name, LoggerLayout layout)
 Creates the object. More...
 
LoggerLayout getLayout ()
 Returns the layout for the appender.
 
 setLayout (LoggerLayout layout)
 Assigns a layout to the appender. More...
 
- Public Member Methods inherited from Logger::LoggerAppender
 addFilter (LoggerFilter filter, bool top=False)
 Adds a filter to the chain. More...
 
 close ()
 Releases any resources allocated by the appender and closes it.
 
 constructor (*string name)
 Creates the object. More...
 
list< LoggerFiltergetFilters ()
 Returns the filter chain as a list. More...
 
string getName ()
 Returns the appender name.
 
*LoggerAppenderQueue getQueue ()
 Returns async queue or NOTHING when events are processed synchronously.
 
bool isOpen ()
 Returns True if the appender is open and therefore active.
 
 open ()
 Opens logging resources. More...
 
bool post (LoggerEvent event)
 Posts the given event to the output queue. More...
 
 removeAllFilters ()
 Clears the filter chain by removing all filters.
 
 removeFilter (LoggerFilter filter)
 Removes the given filter from the filter chain. More...
 
 setQueue (*LoggerAppenderQueue queue)
 Sets the appender queue. More...
 

Public Attributes

const DEFAULT_ARCHIVE_PATTERN = "%p%f.%i"
 default archive pattern
 
- Public Attributes inherited from Logger::AbstractLoggerAppenderFileRotate
const DEFAULT_ROTATION_COUNT = 10
 default value for rotation chain
 
const EVENT_ROTATE = 10001
 rotate event
 
- Public Attributes inherited from Logger::LoggerAppenderFile
const EVENT_REOPEN = 1001
 reopen event
 
- Public Attributes inherited from Logger::LoggerAppender
const EVENT_CLOSE = 3
 close event
 
const EVENT_LOG = 2
 logging event
 
const EVENT_OPEN = 1
 open event
 

Private Member Methods

*string resolveField (auto data, string key, *string option)
 Returns a string for a format field for a pattern-based filename. More...
 
- Private Member Methods inherited from Logger::LoggerAppenderWithLayout
auto serializeImpl (LoggerEvent event)
 Returns the value formatted using the layout pattern. More...
 
- Private Member Methods inherited from Logger::LoggerAppender
bool pushEvent (int type, auto params)
 Pushes the given event on the queue or calls processEventImpl() in case of synchronous processing. More...
 
 constructor (string pattern)
 Creates the object. More...
 
string format (auto data)
 Formats the event record with the current pattern. More...
 
string getPattern ()
 Returns the current pattern.
 
 setPattern (string value)
 Sets the new pattern. More...
 

Additional Inherited Members

- Private Attributes inherited from Logger::LoggerPattern
list< auto > parsedPattern
 parsed pattern; list elements may be strings or hashes
 
const ESCAPE_CHAR = "%"
 format escape character
 

Detailed Description

Implements appender writing to a file with file rotation support.

The events will be logged to a file until rotation occurs. At that moment the current file is closed, archive chain is moved, new file is created and logging continues there.

Member Function Documentation

◆ constructor()

Logger::LoggerAppenderFileRotate::constructor ( *string  name,
LoggerLayout  layout,
string  filename,
int  count = DEFAULT_ROTATION_COUNT,
string  archive = DEFAULT_ARCHIVE_PATTERN,
*string  encoding 
)

Creates the object.

Parameters
namethe name of the appender
layoutthe layout for the appender
filenamewith pattern support; see below for more information
countnumber of files in rotation chain, if count is <=0 then no ratation is performed
archivepattern to evaluate archive filename; see below for more information
encodingthe encoding of the output file

The following table explains the characters used in LoggerPattern for both filename and archive parameter

Conversion character Meaning
%s Used to output the OS directory separator, i.e. "\" or "/"
%c Used to output the appender name
%C Used to output the appender class name
%E Used to output the environment variable with name given by option, e.g. "%E{HOME}"
%% The literal percent sign. "%%" will print a "%" sign

The following table explains the characters used in LoggerPattern for archive parameter only

Conversion character Meaning
%P Used to output the current logging path with filename
%p Used to output the current logging path
%f Used to output the current logging filename
%i Used to output the current file index from 1 to count. option may specify sprintf() format, e.g. "%.3d"
%n Used to output the rotation count. Option may specify sprintf() format, e.g. "%.3d"

For example, the archive pattern "%p%f.%i" rotates log file "/var/run/log/MyLogger.log" to: "/var/run/log/MyLogger.log.1" "/var/run/log/MyLogger.log.2" "/var/run/log/MyLogger.log.3".

◆ getArchiveFileName()

string Logger::LoggerAppenderFileRotate::getArchiveFileName ( int  idx)

Returns the archive filename.

Parameters
idxthe index of file (1..count)

◆ processEventImpl()

Logger::LoggerAppenderFileRotate::processEventImpl ( int  type,
auto  params 
)
virtual

Implements filename rotation; handles the open and rotate events directly; passes all other events to the subclass for handling.

Parameters
typethe event type
paramsevent parameters

Reimplemented from Logger::LoggerAppenderFile.

◆ resolveField()

*string Logger::LoggerAppenderFileRotate::resolveField ( auto  data,
string  key,
*string  option 
)
privatevirtual

Returns a string for a format field for a pattern-based filename.

Parameters
datainput context reference data
keythe format character
optionthe format option value, if any
Returns
the formatted string

Implements Logger::LoggerPattern.