org.jmxtrans.embedded.output

Interface OutputWriter

All Known Implementing Classes:

AbstractOutputWriter, ConsoleWriter, CopperEggWriter, CsvWriter, GraphiteHttpWriter, GraphitePickleWriter, GraphiteWriter, LibratoWriter, NoOpWriter, Slf4jWriter, StackdriverWriter, StatsDWriter

public interface OutputWriter

Interface of define a writer that will convert the collected JMX metrics to a given format (e.g. file, Graphite, ...)

Author:

Cyrille Le Clerc, Jon Stevens

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getSettings() Configuration settings of the OutputWriter.
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setSettings(Map<String,Object> settings) Sets the configuration setting of the OutputWriter.
void	start() Initialize the OutputWriter.
void	stop() Stops the underlying resources of the OutputWriter.
void	write(Iterable<QueryResult> results) Write all the given QueryResult to the target system.

Method Detail

getSettings

Map<String,Object> getSettings()

Configuration settings of the OutputWriter.

setSettings

void setSettings(Map<String,Object> settings)

Sets the configuration setting of the OutputWriter.

write

void write(Iterable<QueryResult> results)

Write all the given QueryResult to the target system.

start

@PostConstruct
void start()
                   throws Exception

Initialize the OutputWriter. Called at the startup of the EmbeddedJmxTrans. This is the place to load the configuration (from the injected settings) and to initialize writer's resource like object pools. Writer are started even if isEnabled() is false.

Throws:

Exception

stop

@PreDestroy
void stop()
               throws Exception

Stops the underlying resources of the OutputWriter. Called at the shutdown of the EmbeddedJmxTrans. This is the place to stop the writer's resources like object pools, threads and sockets.

Throws:

Exception

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)