com.googlecode.jmxtrans.model.output

Class Log4JWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.Log4JWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, AutoCloseable

public class Log4JWriter
extends BaseOutputWriter

A writer for Log4J. It may be a nice way to send JMX metrics to Logstash for example.

Here is an example of MDC variables that are set by this class.

server: localhost_9003
metric: sun_management_MemoryImpl.HeapMemoryUsage_committed
value: 1251999744
resultAlias: myHeapMemoryUsage
attributeName: HeapMemoryUsage
key: committed
epoch: 1388343325728

Author:

Yannick Robin

Field Summary

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
Log4JWriter(com.google.common.collect.ImmutableList<String> typeNames, boolean booleanAsNumber, Boolean debugEnabled, String logger, Map<String,Object> settings)

Method Summary

Modifier and Type	Method and Description
String	getLogger()
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results) Set the log context and log
void	validateSetup(Server server, Query query)

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

close, 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

Constructor Detail

Log4JWriter

public Log4JWriter(com.google.common.collect.ImmutableList<String> typeNames,
                   boolean booleanAsNumber,
                   Boolean debugEnabled,
                   String logger,
                   Map<String,Object> settings)

Method Detail

validateSetup

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

Throws:

ValidationException

internalWrite

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

Set the log context and log

Specified by:

internalWrite in class BaseOutputWriter

Throws:

Exception

getLogger

public String getLogger()