com.googlecode.jmxtrans.model.output

Class KeyOutWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.KeyOutWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, java.lang.AutoCloseable

Direct Known Subclasses:

DailyKeyOutWriter

public class KeyOutWriter
extends BaseOutputWriter

Writes out data in the same format as the GraphiteWriter, except to a file and tab delimited. Takes advantage of Logback RollingFileAppender to automatically handle rolling the files after they reach a certain size.

The default max size of the log files are 10MB (maxLogFileSize) The default number of rolled files to keep is 200 (maxLogBackupFiles)

Author:

jon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyOutWriter.LogWriter Simple class which extends the Writer Class in order to use our logger with the GraphiteWriter2 implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_DELIMITER
protected static java.lang.String	DEFAULT_LOG_PATTERN
protected static int	LOG_IO_BUFFER_SIZE_BYTES
protected static ch.qos.logback.classic.LoggerContext	loggerContext Logback logger factory
protected static java.util.Map<java.lang.String,ch.qos.logback.classic.Logger>	loggers
protected static int	MAX_LOG_BACKUP_FILES
protected static java.lang.String	MAX_LOG_FILE_SIZE
protected static java.lang.String	SETTING_DELIMITER
protected static java.lang.String	SETTING_LOG_PATTERN
protected static java.lang.String	SETTING_MAX_BACK_FILES
protected static java.lang.String	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
KeyOutWriter(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 logPattern, 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.Appender	buildAppender(java.lang.String loggerName, java.lang.String fileStr)
protected ch.qos.logback.core.encoder.Encoder	buildEncoder()
protected ch.qos.logback.classic.Logger	buildLogger(java.lang.String fileStr) Initializes the logger.
protected java.lang.String	buildLoggerName()
protected ch.qos.logback.core.rolling.RollingPolicy	buildRollingPolicy(ch.qos.logback.core.FileAppender<?> appender, java.lang.String fileStr)
protected ch.qos.logback.core.rolling.TriggeringPolicy	buildTriggeringPolicy()
void	close()
java.lang.String	getDelimiter()
java.lang.Integer	getMaxLogBackupFiles()
java.lang.String	getMaxLogFileSize()
java.lang.String	getOutputFile()
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results) The meat of the output.
void	validateSetup(Server server, Query query) Creates the logging

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

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

Field Detail

loggerContext

protected static final ch.qos.logback.classic.LoggerContext loggerContext

Logback logger factory

SETTING_MAX_LOG_FILE_SIZE

protected static final java.lang.String SETTING_MAX_LOG_FILE_SIZE

See Also:

Constant Field Values

SETTING_MAX_BACK_FILES

protected static final java.lang.String SETTING_MAX_BACK_FILES

See Also:

Constant Field Values

SETTING_LOG_PATTERN

protected static final java.lang.String SETTING_LOG_PATTERN

See Also:

Constant Field Values

SETTING_DELIMITER

protected static final java.lang.String SETTING_DELIMITER

See Also:

Constant Field Values

LOG_IO_BUFFER_SIZE_BYTES

protected static final int LOG_IO_BUFFER_SIZE_BYTES

See Also:

Constant Field Values

loggers

protected static final java.util.Map<java.lang.String,ch.qos.logback.classic.Logger> loggers

MAX_LOG_BACKUP_FILES

protected static final int MAX_LOG_BACKUP_FILES

See Also:

Constant Field Values

MAX_LOG_FILE_SIZE

protected static final java.lang.String MAX_LOG_FILE_SIZE

See Also:

Constant Field Values

DEFAULT_LOG_PATTERN

protected static final java.lang.String DEFAULT_LOG_PATTERN

See Also:

Constant Field Values

DEFAULT_DELIMITER

protected static final java.lang.String DEFAULT_DELIMITER

See Also:

Constant Field Values

Constructor Detail

KeyOutWriter

public KeyOutWriter(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 logPattern,
                    java.lang.String delimiter,
                    java.util.Map<java.lang.String,java.lang.Object> settings)

Method Detail

validateSetup

public void validateSetup(Server server,
                          Query query)
                   throws ValidationException

Creates the logging

Throws:

ValidationException

internalWrite

public void internalWrite(Server server,
                          Query query,
                          com.google.common.collect.ImmutableList<Result> results)
                   throws java.lang.Exception

The meat of the output. Reuses the GraphiteWriter2 class but writes in a logfile instead of a network socket.

Specified by:

internalWrite in class BaseOutputWriter

Throws:

java.lang.Exception

buildLogger

protected ch.qos.logback.classic.Logger buildLogger(java.lang.String fileStr)
                                             throws java.io.IOException

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

Parameters:

fileStr -

Returns:

a new Logger instance for the given fileStr

Throws:

java.io.IOException

buildLoggerName

protected java.lang.String buildLoggerName()

buildEncoder

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

buildRollingPolicy

protected ch.qos.logback.core.rolling.RollingPolicy buildRollingPolicy(ch.qos.logback.core.FileAppender<?> appender,
                                                                       java.lang.String fileStr)

buildTriggeringPolicy

protected ch.qos.logback.core.rolling.TriggeringPolicy buildTriggeringPolicy()

buildAppender

protected ch.qos.logback.core.Appender buildAppender(java.lang.String loggerName,
                                                     java.lang.String fileStr)

close

public void close()

Specified by:

close in interface OutputWriter

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class BaseOutputWriter

getMaxLogFileSize

public java.lang.String getMaxLogFileSize()

getMaxLogBackupFiles

public java.lang.Integer getMaxLogBackupFiles()

getDelimiter

public java.lang.String getDelimiter()

getOutputFile

public java.lang.String getOutputFile()