Package org.jmxtrans.agent

Class AbstractOutputWriter

java.lang.Object

org.jmxtrans.agent.AbstractOutputWriter

All Implemented Interfaces:

OutputWriter

Direct Known Subclasses:

ConsoleOutputWriter, DevNullOutputWriter, FileOverwriterOutputWriter, GraphitePlainTextTcpOutputWriter, GraphiteUdpOutputWriter, InfluxDbOutputWriter, LibratoWriter, OutputWritersChain, PerMinuteSummarizerOutputWriter, RollingFileOutputWriter, StackdriverWriter, StatsDOutputWriter, ZabbixTcpOutputWriter

public abstract class AbstractOutputWriter
extends Object
implements OutputWriter

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger
static String	SETTING_LOG_LEVEL	Define the level of log message to display tweaking java.util.logging configuration.
static String	SETTING_LOG_LEVEL_DEFAULT_VALUE

Constructor Summary

Constructors

Constructor	Description
AbstractOutputWriter()

Method Summary

Modifier and Type	Method	Description
protected Level	getDebugLevel()	To workaround the complex configuration of java.util.logging, we tweak the level for "debug style" messages using the "logLevel" initialization parameter.
protected Level	getInfoLevel()	To workaround the complex configuration of java.util.logging, we tweak the level for "info style" messages using the "logLevel" initialization parameter.
protected Level	getTraceLevel()	To workaround the complex configuration of java.util.logging, we tweak the level for "trace style" messages using the "logLevel" initialization parameter.
void	postCollect()	called after a serie of writes, typically at the end of a collection.
void	postConstruct(Map<String,String> settings)
void	preCollect()	Called before metrics collection starts
void	preDestroy()
abstract void	writeInvocationResult(String invocationName, Object value)
abstract void	writeQueryResult(String metricName, String metricType, Object value)

Methods inherited from class java.lang.Object

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

Field Details

SETTING_LOG_LEVEL

public static final String SETTING_LOG_LEVEL

Define the level of log message to display tweaking java.util.logging configuration. Supported values are INFO

See Also:

Constant Field Values

SETTING_LOG_LEVEL_DEFAULT_VALUE

public static final String SETTING_LOG_LEVEL_DEFAULT_VALUE

See Also:

Constant Field Values

logger

protected final Logger logger

Constructor Details

AbstractOutputWriter

public AbstractOutputWriter()

Method Details

postConstruct

public void postConstruct(@Nonnull
Map<String,String> settings)

Specified by:

postConstruct in interface OutputWriter

preDestroy

public void preDestroy()

Specified by:

preDestroy in interface OutputWriter

postCollect

public void postCollect()
                 throws IOException

Description copied from interface: OutputWriter

called after a serie of writes, typically at the end of a collection.

Useful with batch writers.

Specified by:

postCollect in interface OutputWriter

Throws:

IOException

preCollect

public void preCollect()
                throws IOException

Description copied from interface: OutputWriter

Called before metrics collection starts

Specified by:

preCollect in interface OutputWriter

Throws:

IOException

writeInvocationResult

public abstract void writeInvocationResult(@Nonnull
String invocationName,
@Nullable
Object value)
                                    throws IOException

Specified by:

writeInvocationResult in interface OutputWriter

Throws:

IOException

writeQueryResult

public abstract void writeQueryResult(@Nonnull
String metricName,
@Nullable
String metricType,
@Nullable
Object value)
                               throws IOException

Specified by:

writeQueryResult in interface OutputWriter

metricType - see Query.type

Throws:

IOException

getDebugLevel

@Nonnull
protected Level getDebugLevel()

To workaround the complex configuration of java.util.logging, we tweak the level for "debug style" messages using the "logLevel" initialization parameter.

getTraceLevel

@Nonnull
protected Level getTraceLevel()

To workaround the complex configuration of java.util.logging, we tweak the level for "trace style" messages using the "logLevel" initialization parameter.

getInfoLevel

@Nonnull
protected Level getInfoLevel()

To workaround the complex configuration of java.util.logging, we tweak the level for "info style" messages using the "logLevel" initialization parameter.