com.googlecode.jmxtrans.model.output

Class OpenTSDBGenericWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.OpenTSDBGenericWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, AutoCloseable

Direct Known Subclasses:

OpenTSDBWriter, TCollectorUDPWriter

public abstract class OpenTSDBGenericWriter
extends BaseOutputWriter

Originally written by Balazs Kossovics . Common base class for OpenTSDBWriter and TCollectorWriter. Date: 4/4/13 Time: 6:00 PM

Updates by Arthur Naseef

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_MERGE_TYPE_NAMES_TAGS
protected String	host
protected OpenTSDBMessageFormatter	messageFormatter
protected Integer	port

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
OpenTSDBGenericWriter(com.google.common.collect.ImmutableList<String> typeNames, boolean booleanAsNumber, Boolean debugEnabled, String host, Integer port, Map<String,String> tags, String tagName, Boolean mergeTypeNamesTags, String metricNamingExpression, Boolean addHostnameTag, Map<String,Object> settings)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finishOutput() Complete a batch of results output, if needed.
protected abstract boolean	getAddHostnameTagDefault() Subclass responsibility: specify the default value for the "addHostnameTag" setting.
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results) Write the results of the query.
protected void	prepareSender() Prepare for sending metrics, if needed.
protected abstract void	sendOutput(String metricLine) Subcall responsibility: method to perform the actual output for the given metric line.
protected void	shutdownSender() Shutdown the sender, if needed.
void	start() Start the output writer.
protected void	startOutput() Prepare a batch of results output, if needed.
void	validateSetup(Server server, Query query) Validation per query, after the writer has been start()ed

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MERGE_TYPE_NAMES_TAGS

public static final boolean DEFAULT_MERGE_TYPE_NAMES_TAGS

See Also:

Constant Field Values

host

protected final String host

port

protected final Integer port

messageFormatter

protected final OpenTSDBMessageFormatter messageFormatter

Constructor Detail

OpenTSDBGenericWriter

public OpenTSDBGenericWriter(com.google.common.collect.ImmutableList<String> typeNames,
                             boolean booleanAsNumber,
                             Boolean debugEnabled,
                             String host,
                             Integer port,
                             Map<String,String> tags,
                             String tagName,
                             Boolean mergeTypeNamesTags,
                             String metricNamingExpression,
                             Boolean addHostnameTag,
                             Map<String,Object> settings)
                      throws LifecycleException

Throws:

LifecycleException

Method Detail

prepareSender

protected void prepareSender()
                      throws LifecycleException

Prepare for sending metrics, if needed. For use by subclasses.

Throws:

LifecycleException

shutdownSender

protected void shutdownSender()
                       throws LifecycleException

Shutdown the sender, if needed. For use by subclasses.

Throws:

LifecycleException

startOutput

protected void startOutput()
                    throws IOException

Prepare a batch of results output, if needed. For use by subclasses.

Throws:

IOException

getAddHostnameTagDefault

protected abstract boolean getAddHostnameTagDefault()

Subclass responsibility: specify the default value for the "addHostnameTag" setting.

sendOutput

protected abstract void sendOutput(String metricLine)
                            throws IOException

Subcall responsibility: method to perform the actual output for the given metric line. Every subclass must implement this method.

Parameters:

metricLine - - the line containing the metric name, value, and tags for a single metric; excludes the "put" keyword expected by OpenTSDB and the trailing newline character.

Throws:

IOException

finishOutput

protected void finishOutput()
                     throws IOException

Complete a batch of results output, if needed. For use by subclasses.

Throws:

IOException

internalWrite

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

Write the results of the query.

Specified by:

internalWrite in class BaseOutputWriter

Parameters:

server -

query - - the query and its results.

results -

Throws:

Exception

validateSetup

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

Validation per query, after the writer has been start()ed

Throws:

ValidationException

start

public void start()
           throws LifecycleException

Start the output writer. At this time, the settings are read from the configuration file and saved for later use.

Specified by:

start in interface OutputWriter

Overrides:

start in class BaseOutputWriter

Throws:

LifecycleException

close

public void close()
           throws LifecycleException

Specified by:

close in interface OutputWriter

Specified by:

close in interface AutoCloseable

Overrides:

close in class BaseOutputWriter

Throws:

LifecycleException