com.googlecode.jmxtrans.model.output

Class DailyKeyOutWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.KeyOutWriter

com.googlecode.jmxtrans.model.output.DailyKeyOutWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, AutoCloseable

public class DailyKeyOutWriter
extends KeyOutWriter

This class is derived from KeyOutWriter. It uses DailyRollingFileAppender instead of RollingFileAppender. Writes out data in the same format as the GraphiteWriter, except to a file and tab delimited. Takes advantage of Log4J DailyRollingFileAppender to automatically handle rolling the files at defined intervals (datePattern). Note that this writer will NOT clean up after itself. The files will not be deleted. It is up to the user to clean things up. The datePattern is taken directly from DailyRollingFileAppender DatePattern. The default datePattern will roll the files at midnight once a day ("'.'yyyy-MM-dd") See the documentation for DailyRollingFileAppender for other useful patterns.

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
DailyKeyOutWriter(com.google.common.collect.ImmutableList<String> typeNames, boolean booleanAsNumber, Boolean debugEnabled, String outputFile, String maxLogFileSize, int maxLogBackupFiles, String delimiter, String datePattern, Map<String,Object> settings)

Method Summary

Modifier and Type	Method and Description
protected org.apache.log4j.Appender	buildLog4jAppender(String fileStr, String maxLogFileSize, Integer maxLogBackupFiles) The maxLogFileSize and maxLogBackupFiles are ignored as per the existing behaviour of DailyKeyOutWriter.
protected String	buildLoggerName()
String	getDatePattern()

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

buildLog4jLoggerFactory, getDelimiter, getMaxLogBackupFiles, getMaxLogFileSize, getOutputFile, initLogger, 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

DailyKeyOutWriter

public DailyKeyOutWriter(com.google.common.collect.ImmutableList<String> typeNames,
                         boolean booleanAsNumber,
                         Boolean debugEnabled,
                         String outputFile,
                         String maxLogFileSize,
                         int maxLogBackupFiles,
                         String delimiter,
                         String datePattern,
                         Map<String,Object> settings)

Method Detail

buildLog4jAppender

protected org.apache.log4j.Appender buildLog4jAppender(String fileStr,
                                                       String maxLogFileSize,
                                                       Integer maxLogBackupFiles)
                                                throws IOException

The maxLogFileSize and maxLogBackupFiles are ignored as per the existing behaviour of DailyKeyOutWriter.

Overrides:

buildLog4jAppender in class KeyOutWriter

Throws:

IOException

buildLoggerName

protected String buildLoggerName()

Overrides:

buildLoggerName in class KeyOutWriter

getDatePattern

public String getDatePattern()