com.googlecode.jmxtrans.model.output

Class TimeBasedRollingKeyOutWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.KeyOutWriter

com.googlecode.jmxtrans.model.output.TimeBasedRollingKeyOutWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, java.lang.AutoCloseable

public class TimeBasedRollingKeyOutWriter
extends KeyOutWriter

Extension of KeyOutWriter to use Logback for its logging. This version supports outputting with a time and size based rollover policy but with no file rename taking place. The filename remains constant for the output file from its creation to the roll over to a new file. Then the old file remains with its old name and the new file is used for further logging. We found this to be useful when dealing with forwarding logs on Windows as our other support applications were not able to handle the rename correctly on Windows and DailyKeyOutWriter caused the original file to be renamed. Also DailyRollingAppender has bugs that can cause data loss and it is no longer recommended for use judging by the javadocs for it. The basic operation is to set the date time to rollover in the outputFile setting. For example: "outputFile": "testing-here.log%d{yyyy-MM-dd}.%i", In this case we have set the logging to roll over every day. There is also a default max size as per the KeyOutWriter. If the file exceeds the default max the .%i integer is increments. See the Logstash documentation for more information.

Field Summary

Fields inherited from class com.googlecode.jmxtrans.model.output.KeyOutWriter

DEFAULT_DELIMITER, LOG_IO_BUFFER_SIZE_BYTES, LOG_PATTERN, log4jLoggerFactory, logger, loggers, MAX_LOG_BACKUP_FILES, MAX_LOG_FILE_SIZE, SETTING_DELIMITER, SETTING_MAX_BACK_FILES, SETTING_MAX_LOG_FILE_SIZE

Fields inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

BINARY_PATH, BOOLEAN_AS_NUMBER, DEBUG, HOST, OUTPUT_FILE, PORT, TEMPLATE_FILE, TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description
TimeBasedRollingKeyOutWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames, boolean booleanAsNumber, java.lang.Boolean debugEnabled, java.lang.String outputFile, java.lang.String maxLogFileSize, java.lang.Integer maxLogBackupFiles, java.lang.String delimiter, java.util.Map<java.lang.String,java.lang.Object> settings)

Method Summary

Modifier and Type	Method and Description
protected ch.qos.logback.core.encoder.Encoder	buildEncoder()
protected org.slf4j.Logger	getAndConfigureLogger(ch.qos.logback.core.Appender appender)
protected java.lang.String	getSettingOutputPattern()
protected org.slf4j.Logger	initLogger(java.lang.String fileStr) Initializes the logger.
protected ch.qos.logback.core.rolling.RollingPolicy	initRollingPolicy(java.lang.String fileName, int maxBackupFiles, ch.qos.logback.core.util.FileSize maxFileSize)

Methods inherited from class com.googlecode.jmxtrans.model.output.KeyOutWriter

buildLog4jAppender, buildLog4jLoggerFactory, buildLoggerName, getDelimiter, getMaxLogBackupFiles, getMaxLogFileSize, getOutputFile, internalWrite, validateSetup

Methods inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

close, create, doWrite, firstNonNull, getConcatedTypeNameValues, getSettings, getTypeNames, isDebugEnabled, start, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeBasedRollingKeyOutWriter

public TimeBasedRollingKeyOutWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames,
                                    boolean booleanAsNumber,
                                    java.lang.Boolean debugEnabled,
                                    java.lang.String outputFile,
                                    java.lang.String maxLogFileSize,
                                    java.lang.Integer maxLogBackupFiles,
                                    java.lang.String delimiter,
                                    java.util.Map<java.lang.String,java.lang.Object> settings)

Method Detail

initLogger

protected org.slf4j.Logger initLogger(java.lang.String fileStr)
                               throws java.io.IOException

Description copied from class: KeyOutWriter

Initializes the logger. This is called when we need to create a new logger for the given file name.

Overrides:

initLogger in class KeyOutWriter

Returns:

a new Logger instance for the given fileStr

Throws:

java.io.IOException

getAndConfigureLogger

protected org.slf4j.Logger getAndConfigureLogger(ch.qos.logback.core.Appender appender)

buildEncoder

protected ch.qos.logback.core.encoder.Encoder buildEncoder()

initRollingPolicy

protected ch.qos.logback.core.rolling.RollingPolicy initRollingPolicy(java.lang.String fileName,
                                                                      int maxBackupFiles,
                                                                      ch.qos.logback.core.util.FileSize maxFileSize)

getSettingOutputPattern

protected java.lang.String getSettingOutputPattern()