org.jmxtrans.agent

Interface OutputWriter

All Known Implementing Classes:

AbstractOutputWriter, ConsoleOutputWriter, DevNullOutputWriter, FileOverwriterOutputWriter, GraphitePlainTextTcpOutputWriter, GraphiteUdpOutputWriter, InfluxDbOutputWriter, LibratoWriter, OutputWriterCircuitBreakerDecorator, OutputWritersChain, PerMinuteSummarizerOutputWriter, RollingFileOutputWriter, StackdriverWriter, StatsDOutputWriter, SummarizingConsoleOutputWriter, SummarizingFileOverwriterOutputWriter, ZabbixTcpOutputWriter

public interface OutputWriter

Author:

Cyrille Le Clerc

Method Summary

Modifier and Type	Method and Description
void	postCollect() called after a serie of writes, typically at the end of a collection.
void	postConstruct(java.util.Map<java.lang.String,java.lang.String> settings)
void	preCollect() Called before metrics collection starts
void	preDestroy()
void	writeInvocationResult(java.lang.String invocationName, java.lang.Object value)
void	writeQueryResult(java.lang.String metricName, java.lang.String metricType, java.lang.Object value)

Method Detail

postConstruct

void postConstruct(@Nonnull
                   java.util.Map<java.lang.String,java.lang.String> settings)

preDestroy

void preDestroy()

preCollect

void preCollect()
         throws java.io.IOException

Called before metrics collection starts

Throws:

java.io.IOException

writeQueryResult

void writeQueryResult(@Nonnull
                      java.lang.String metricName,
                      @Nullable
                      java.lang.String metricType,
                      @Nullable
                      java.lang.Object value)
               throws java.io.IOException

Parameters:

metricName -

metricType - see Query.type

value -

Throws:

java.io.IOException

postCollect

void postCollect()
          throws java.io.IOException

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

Useful with batch writers.

Throws:

java.io.IOException

writeInvocationResult

void writeInvocationResult(@Nonnull
                           java.lang.String invocationName,
                           @Nullable
                           java.lang.Object value)
                    throws java.io.IOException

Throws:

java.io.IOException