LogFileSink Class Reference

A logging sink for file, which supports log file rotation and daily log files. More...

#include <error/LogFileSink.h>

Inheritance diagram for LogFileSink:

Public Member Functions
	LogFileSink (const std::string &logFilePrefix, int logFileRotationDepth=0, bool useDailyLogFiles=false, Duration dailyLogFileStart=Duration(0, 0, 0))
	Default constructor. More...
	LogFileSink (const LogFileSink &other)
	The copy constructor. More...
virtual void	consume (const LogRecord &record)
	Implementation of LogSink. More...
void	aboutToConsume (const LogRecord &record)
	Is called by LogCore singleton whenever a new log record is written. More...
void	resetFilter ()
	Resets the log filter. More...
template<typename T >
LogFilterPtr	setFilter (const T &filter)
	Set the filter. More...
void	resetFormatter ()
	Resets the formatter. More...
template<typename T >
LogFormatterPtr	setFormatter (const T &formatter)
	Set the formatter. More...

Protected Attributes
LogFormatterPtr	mFormatter
LogFilterPtr	mFilter

Detailed Description

A logging sink for file, which supports log file rotation and daily log files.

Based on the settings mFileRotationDepth, mDailyLogFiles and mDailyLogFileStart, this log sink will create log files according the following scheme:

• mFileRotationDepth = 0:
  • mDailyLogFiles = false:
    • Log file naming scheme:
      • logFilePrefix.log
    • Overwrites the log file at each start.
  • mDailyLogFiles = true:
    • Log file naming scheme:
      • logFilePrefix_YYYY-MM-DD.log
    • The log file will contain all messages starting at the specified time (mDailyLogFileStart) of the day. Log messages before this time will be written into the file of the day before.
    • If the log sink is started multiple times (e.g. multiple starts on one day), the log messages will be appended to the already existing log file.
• mFileRotationDepth > 0:
  • mDailyLogFiles = false:
    • Log file naming scheme:
      • logFilePrefix.log (current start)
      • logFilePrefix.log.1 (log of one start ago)
      • logFilePrefix.log.2 (log of two starts ago)
    • Creates a new log file for each start, until mFileRotationDepth is reached. Older log files will be deleted.
  • mDailyLogFiles = true:
    • Log file naming scheme:
      • logFilePrefix_YYYY-MM-DD.log (current day)
      • logFilePrefix_YYYY-MM-(DD-1).log (one day ago)
      • logFilePrefix_YYYY-MM-(DD-2).log (two days ago)
    • This mode creates a new log file starting at the specified time (mDailyLogFileStart) of the day. Log messages before this time will be written into the file of the day before.
    • The log file which is mFileRotationDepth+1 days old, will be deleted.
    • If the log sink is started multiple times (e.g. multiple starts on one day), the log messages will be appended to the already existing log file.
• mFileRotationDepth < 0:
  • Same behaviour as mFileRotationDepth > 0, but unlimited number of files. Use carefully!

By default, log file rotation and daily log files are disabled. The default daily log file start is midnight.

Note

Using the same logFilePrefix with different settings (especially different values of mFileRotationDepth) might cause an unexpected behaviour, since for performance reasons only the file mFileRotationDepth+1 will be checked and deleted. Older files will not be touched.

Constructor & Destructor Documentation

LogFileSink() [1/2]

LogFileSink	(	const std::string &	logFilePrefix,
		int	logFileRotationDepth = 0,
		bool	useDailyLogFiles = false,
		Duration	dailyLogFileStart = Duration(0, 0, 0)
	)

Default constructor.

LogFileSink() [2/2]

LogFileSink

(

const LogFileSink &

other

)

The copy constructor.

Member Function Documentation

consume()

virtual void consume ( const LogRecord &  record )

virtual

Implementation of LogSink.

Implements LogSink.

aboutToConsume()

void aboutToConsume ( const LogRecord &  record )

inherited

Is called by LogCore singleton whenever a new log record is written.

Parameters

record

The log entry.

resetFilter()

void resetFilter ( )

inlineinherited

Resets the log filter.

No filter will be used to filter log entries.

setFilter()

LogFilterPtr setFilter ( const T &  filter )

inlineinherited

Set the filter.

The filter must be copy constructible since we are creating a copy and inherited from LogFilterBase.

Parameters

filter

The filter object

resetFormatter()

void resetFormatter ( )

inlineinherited

Resets the formatter.

No formatter will be used to format log entries.

setFormatter()

LogFormatterPtr setFormatter ( const T &  formatter )

inlineinherited

Set the formatter.

The formatter must be copy constructible since we are creating a copy and inherited from LogFormatterBase.

Parameters

formatter

The formatter object

Member Data Documentation

mFormatter

LogFormatterPtr mFormatter

protectedinherited

mFilter

LogFilterPtr mFilter

protectedinherited

---

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

• base/include/error/LogFileSink.h