me.moocar.logbackgelf

Class GelfLayout<E extends ch.qos.logback.classic.spi.ILoggingEvent>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.LayoutBase<E>

me.moocar.logbackgelf.GelfLayout<E>

All Implemented Interfaces:

ch.qos.logback.core.Layout<E>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class GelfLayout<E extends ch.qos.logback.classic.spi.ILoggingEvent>
extends ch.qos.logback.core.LayoutBase<E>

Responsible for formatting a log event into a GELF JSON string

Field Summary

Fields inherited from class ch.qos.logback.core.LayoutBase

started

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

context

Constructor Summary

Constructors

Constructor and Description
GelfLayout()

Method Summary

Modifier and Type	Method and Description
void	addAdditionalField(String keyValue) Add an additional field.
void	addFieldType(String keyValue)
void	addStaticAdditionalField(String keyValue) Add a staticAdditional field.
String	doLayout(E event)
Map<String,String>	getAdditionalFields() additional fields to add to the gelf message.
Map<String,String>	getFieldTypes()
ch.qos.logback.core.Layout	getFullMessageLayout()
String	getHost() Override the local host using a config option
ch.qos.logback.core.Layout	getShortMessageLayout()
Map<String,String>	getStaticAdditionalFields() static additional fields to add to every gelf message.
boolean	isIncludeFullMDC() Indicates if all values from the MDC should be included in the gelf message or only the once listed as additional fields.
boolean	isUseLoggerName() If true, an additional field call "_loggerName" will be added to each gelf message.
boolean	isUseMarker()
boolean	isUseThreadName() If true, an additional field call "_threadName" will be added to each gelf message.
void	setAdditionalFields(Map<String,String> additionalFields)
void	setFieldTypes(Map<String,String> fieldTypes)
void	setFullMessageLayout(ch.qos.logback.core.Layout fullMessageLayout)
void	setHost(String host)
void	setIncludeFullMDC(boolean includeFullMDC)
void	setShortMessageLayout(ch.qos.logback.core.Layout shortMessageLayout)
void	setStaticAdditionalFields(Map<String,String> staticAdditionalFields)
void	setUseLoggerName(boolean useLoggerName)
void	setUseMarker(boolean useMarker)
void	setUseThreadName(boolean useThreadName)
void	start()

Methods inherited from class ch.qos.logback.core.LayoutBase

getContentType, getContext, getFileFooter, getFileHeader, getPresentationFooter, getPresentationHeader, isStarted, setContext, setFileFooter, setFileHeader, setPresentationFooter, setPresentationHeader, stop

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

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getDeclaredOrigin, getStatusManager

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

Constructor Detail

GelfLayout

public GelfLayout()

Method Detail

start

public void start()

Specified by:

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

Overrides:

start in class ch.qos.logback.core.LayoutBase<E extends ch.qos.logback.classic.spi.ILoggingEvent>

doLayout

public String doLayout(E event)

isUseLoggerName

public boolean isUseLoggerName()

If true, an additional field call "_loggerName" will be added to each gelf message. Its contents will be the fully qualified name of the logger. e.g: com.company.Thingo.

setUseLoggerName

public void setUseLoggerName(boolean useLoggerName)

isUseMarker

public boolean isUseMarker()

setUseMarker

public void setUseMarker(boolean useMarker)

isUseThreadName

public boolean isUseThreadName()

If true, an additional field call "_threadName" will be added to each gelf message. Its contents will be the Name of the thread. Defaults to "false".

setUseThreadName

public void setUseThreadName(boolean useThreadName)

getAdditionalFields

public Map<String,String> getAdditionalFields()

additional fields to add to the gelf message. Here's how these work:
Let's take an example. I want to log the client's ip address of every request that comes into my web server. To do this, I add the ipaddress to the slf4j MDC on each request as follows: ... MDC.put("ipAddress", "44.556.345.657"); ... Now, to include the ip address in the gelf message, i just add the following to my logback.groovy: appender("GELF", GelfAppender) { ... additionalFields = [identity:"_identity"] ... } in the additionalFields map, the key is the name of the MDC to look up. the value is the name that should be given to the key in the additional field in the gelf message.

setAdditionalFields

public void setAdditionalFields(Map<String,String> additionalFields)

getStaticAdditionalFields

public Map<String,String> getStaticAdditionalFields()

static additional fields to add to every gelf message. Key is the additional field key (and should thus begin with an underscore). The value is a static string.

setStaticAdditionalFields

public void setStaticAdditionalFields(Map<String,String> staticAdditionalFields)

isIncludeFullMDC

public boolean isIncludeFullMDC()

Indicates if all values from the MDC should be included in the gelf message or only the once listed as additional fields.

If true, the gelf message will contain all values available in the MDC. Each MDC key will be converted to a gelf custom field by adding an underscore prefix. If an entry exists in additional field it will be used instead.

If false, only the fields listed in additional field will be included in the message.

Returns:

the includeFullMDC

setIncludeFullMDC

public void setIncludeFullMDC(boolean includeFullMDC)

getHost

public String getHost()

Override the local host using a config option

Returns:

the local host (defaults to getLocalHost() if not overridden in config

setHost

public void setHost(String host)

addAdditionalField

public void addAdditionalField(String keyValue)

Add an additional field. This is mainly here for compatibility with logback.xml

Parameters:

keyValue - This must be in format key:value where key is the MDC key, and value is the GELF field name. e.g "ipAddress:_ip_address"

addStaticAdditionalField

public void addStaticAdditionalField(String keyValue)

Add a staticAdditional field. This is mainly here for compatibility with logback.xml

Parameters:

keyValue - This must be in format key:value where key is the additional field key, and value is a static string. e.g "_node_name:www013"

addFieldType

public void addFieldType(String keyValue)

getFieldTypes

public Map<String,String> getFieldTypes()

setFieldTypes

public void setFieldTypes(Map<String,String> fieldTypes)

getFullMessageLayout

public ch.qos.logback.core.Layout getFullMessageLayout()

setFullMessageLayout

public void setFullMessageLayout(ch.qos.logback.core.Layout fullMessageLayout)

getShortMessageLayout

public ch.qos.logback.core.Layout getShortMessageLayout()

setShortMessageLayout

public void setShortMessageLayout(ch.qos.logback.core.Layout shortMessageLayout)