Package org.omegazero.common.logging

Class RotatingFileLoggerOutput

java.lang.Object

org.omegazero.common.logging.FileLoggerOutput

org.omegazero.common.logging.RotatingFileLoggerOutput

All Implemented Interfaces:

LoggerOutput

public class RotatingFileLoggerOutput
extends FileLoggerOutput

A FileLoggerOutput with support for log rotation.

Since:

2.11.0

Field Summary

Fields

Modifier and Type	Field	Description
static final long	CHECK_TIMEOUT	System property org.omegazero.common.logging.rotation.checkTimeout
static final long	MAX_FILE_SIZE_DEFAULT	System property org.omegazero.common.logging.rotation.maxFileSize

Fields inherited from class org.omegazero.common.logging.FileLoggerOutput

LOG_BUFFER_BYTES, SAVE_INTERVAL, SYNC_FLUSH_DEFAULT, writer

Constructor Summary

Constructors

Constructor	Description
RotatingFileLoggerOutput(String logFile, long maxFileSize)	Creates a new RotatingFileLoggerOutput, writing to the given logFile.
RotatingFileLoggerOutput(String logFile, long maxFileSize, int logBufferBytes, int saveInterval)	Creates a new RotatingFileLoggerOutput, writing to the given logFile.

Method Summary

Modifier and Type	Method	Description
void	flush()	Flushes any buffered data to the underlying output.
void	writeLine(String line, String markup)	Writes the given log line to this LoggerOutput.

Methods inherited from class org.omegazero.common.logging.FileLoggerOutput

close, getLogFile, reopen, setSyncFlush

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_FILE_SIZE_DEFAULT

public static final long MAX_FILE_SIZE_DEFAULT

System property org.omegazero.common.logging.rotation.maxFileSize

The default maximum file size for rotation.

Default: 0 (log rotation disabled)

CHECK_TIMEOUT

public static final long CHECK_TIMEOUT

System property org.omegazero.common.logging.rotation.checkTimeout

The time in seconds between rotation checks.

Default: 60

Constructor Details

RotatingFileLoggerOutput

public RotatingFileLoggerOutput(String logFile,
 long maxFileSize)
                         throws IOException

Creates a new RotatingFileLoggerOutput, writing to the given logFile.

Parameters:

logFile - The name of the output log file

maxFileSize - The maximum file size for rotation. If this value is negative, the default is used; if 0, log rotation is disabled

Throws:

IOException - If an IO error occurs while opening the file

See Also:

• RotatingFileLoggerOutput(String, long, int, int)

RotatingFileLoggerOutput

public RotatingFileLoggerOutput(String logFile,
 long maxFileSize,
 int logBufferBytes,
 int saveInterval)
                         throws IOException

Creates a new RotatingFileLoggerOutput, writing to the given logFile.

The maximum file size parameter is not a hard limit on the file size of log files. If the log file exceeds this size, it is rotated, but the file may end up larger than this parameter, especially if there is a lot of log output in a short time.

Parameters:

logFile - The name of the output log file

maxFileSize - The maximum file size for rotation. If this value is negative, the default is used; if 0, log rotation is disabled

logBufferBytes - The size of the internal log data buffer

saveInterval - The save interval

Throws:

IOException - If an IO error occurs while opening the file

See Also:

• FileLoggerOutput(String, int, int)

Method Details

writeLine

public void writeLine(String line,
 String markup)

Description copied from interface: LoggerOutput

Writes the given log line to this LoggerOutput.

Specified by:

writeLine in interface LoggerOutput

Overrides:

writeLine in class FileLoggerOutput

Parameters:

line - The log message

markup - Special terminal escape sequences used for text markup

flush

public void flush()

Description copied from interface: LoggerOutput

Flushes any buffered data to the underlying output.

Specified by:

flush in interface LoggerOutput

Overrides:

flush in class FileLoggerOutput