de.siegmar.logbackgelf

Class GelfEncoder

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>

de.siegmar.logbackgelf.GelfEncoder

All Implemented Interfaces:

ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class GelfEncoder
extends ch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>

This class is responsible for transforming a Logback log event to a GELF message.

Field Summary

Fields inherited from class ch.qos.logback.core.encoder.EncoderBase

started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
GelfEncoder()

Method Summary

Modifier and Type	Method and Description
void	addFieldMapper(GelfFieldMapper<?> fieldMapper)
void	addStaticField(java.lang.String staticField)
byte[]	encode(ch.qos.logback.classic.spi.ILoggingEvent event)
byte[]	footerBytes()
protected byte[]	gelfMessageToJson(GelfMessage gelfMessage) Allow subclasses to customize the message before it is converted to String.
java.util.List<GelfFieldMapper<?>>	getFieldMappers()
ch.qos.logback.classic.PatternLayout	getFullPatternLayout()
java.lang.String	getLevelNameKey()
java.lang.String	getLoggerNameKey()
java.lang.String	getOriginHost()
ch.qos.logback.classic.PatternLayout	getShortPatternLayout()
java.util.Map<java.lang.String,java.lang.Object>	getStaticFields()
java.lang.String	getThreadNameKey()
byte[]	headerBytes()
boolean	isAppendNewline()
boolean	isIncludeCallerData()
boolean	isIncludeLevelName()
boolean	isIncludeMarker()
boolean	isIncludeMdcData()
boolean	isIncludeRawMessage()
boolean	isIncludeRootCauseData()
boolean	isNumbersAsString()
void	setAppendNewline(boolean appendNewline)
void	setFullPatternLayout(ch.qos.logback.classic.PatternLayout fullPatternLayout)
void	setIncludeCallerData(boolean includeCallerData)
void	setIncludeLevelName(boolean includeLevelName)
void	setIncludeMarker(boolean includeMarker)
void	setIncludeMdcData(boolean includeMdcData)
void	setIncludeRawMessage(boolean includeRawMessage)
void	setIncludeRootCauseData(boolean includeRootCauseData)
void	setLevelNameKey(java.lang.String levelNameKey)
void	setLoggerNameKey(java.lang.String loggerNameKey)
void	setNumbersAsString(boolean numbersAsString)
void	setOriginHost(java.lang.String originHost)
void	setShortPatternLayout(ch.qos.logback.classic.PatternLayout shortPatternLayout)
void	setThreadNameKey(java.lang.String threadNameKey)
void	start()

Methods inherited from class ch.qos.logback.core.encoder.EncoderBase

isStarted, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Constructor Detail

GelfEncoder

public GelfEncoder()

Method Detail

getOriginHost

public java.lang.String getOriginHost()

setOriginHost

public void setOriginHost(java.lang.String originHost)

isIncludeRawMessage

public boolean isIncludeRawMessage()

setIncludeRawMessage

public void setIncludeRawMessage(boolean includeRawMessage)

isIncludeMarker

public boolean isIncludeMarker()

setIncludeMarker

public void setIncludeMarker(boolean includeMarker)

isIncludeMdcData

public boolean isIncludeMdcData()

setIncludeMdcData

public void setIncludeMdcData(boolean includeMdcData)

isIncludeCallerData

public boolean isIncludeCallerData()

setIncludeCallerData

public void setIncludeCallerData(boolean includeCallerData)

isIncludeRootCauseData

public boolean isIncludeRootCauseData()

setIncludeRootCauseData

public void setIncludeRootCauseData(boolean includeRootCauseData)

isIncludeLevelName

public boolean isIncludeLevelName()

setIncludeLevelName

public void setIncludeLevelName(boolean includeLevelName)

getLevelNameKey

public java.lang.String getLevelNameKey()

setLevelNameKey

public void setLevelNameKey(java.lang.String levelNameKey)

getLoggerNameKey

public java.lang.String getLoggerNameKey()

setLoggerNameKey

public void setLoggerNameKey(java.lang.String loggerNameKey)

getThreadNameKey

public java.lang.String getThreadNameKey()

setThreadNameKey

public void setThreadNameKey(java.lang.String threadNameKey)

isAppendNewline

public boolean isAppendNewline()

setAppendNewline

public void setAppendNewline(boolean appendNewline)

isNumbersAsString

public boolean isNumbersAsString()

setNumbersAsString

public void setNumbersAsString(boolean numbersAsString)

getShortPatternLayout

public ch.qos.logback.classic.PatternLayout getShortPatternLayout()

setShortPatternLayout

public void setShortPatternLayout(ch.qos.logback.classic.PatternLayout shortPatternLayout)

getFullPatternLayout

public ch.qos.logback.classic.PatternLayout getFullPatternLayout()

setFullPatternLayout

public void setFullPatternLayout(ch.qos.logback.classic.PatternLayout fullPatternLayout)

getStaticFields

public java.util.Map<java.lang.String,java.lang.Object> getStaticFields()

addStaticField

public void addStaticField(java.lang.String staticField)

getFieldMappers

public java.util.List<GelfFieldMapper<?>> getFieldMappers()

addFieldMapper

public void addFieldMapper(GelfFieldMapper<?> fieldMapper)

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class ch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>

headerBytes

public byte[] headerBytes()

encode

public byte[] encode(ch.qos.logback.classic.spi.ILoggingEvent event)

gelfMessageToJson

protected byte[] gelfMessageToJson(GelfMessage gelfMessage)

Allow subclasses to customize the message before it is converted to String.

Parameters:

gelfMessage - the GELF message to serialize.

Returns:

the serialized GELF message (in JSON format).

footerBytes

public byte[] footerBytes()