biz.paluch.logging.gelf.log4j

Class GelfLayout

java.lang.Object

org.apache.log4j.Layout

biz.paluch.logging.gelf.log4j.GelfLayout

All Implemented Interfaces:

org.apache.log4j.spi.OptionHandler

public class GelfLayout
extends org.apache.log4j.Layout

Log-Formatter for JSON using fields specified within GELF. This formatter will produce a JSON object for each log event. Example: { "NDC": "ndc message", "timestamp": "1439319236.722", "SourceClassName": "biz.paluch.logging.gelf.wildfly.WildFlyGelfLogFormatterTest", "SourceMethodName": "testDefaults", "level": "6", "SourceSimpleClassName": "WildFlyGelfLogFormatterTest", "facility": "logstash-gelf", "full_message": "foo bar test log message", "short_message": "foo bar test log message", "MySeverity": "INFO", "LoggerName": "biz.paluch.logging.gelf.wildfly.WildFlyGelfLogFormatterTest", "Thread": "main", "MyTime": "2015-08-11 20:53:56,0722" } Following parameters are supported/needed:

• lineBreak (Optional): End of line, platform dependent default value, see System.getProperty("line.separator")
• fields (Optional): Comma-separated list of log event fields that should be included in the JSON. Defaults to Time, Severity, ThreadName, SourceClassName, SourceMethodName, SourceSimpleClassName, LoggerName, NDC
• originHost (Optional): Originating Hostname, default FQDN Hostname
• extractStackTrace (Optional): Post Stack-Trace to StackTrace field (true/false/throwable reference [0 = throwable, 1 = throwable.cause, -1 = root cause]), default false
• filterStackTrace (Optional): Perform Stack-Trace filtering (true/false), default false
• includeLocation (Optional): Include source code location, default true
• mdcProfiling (Optional): Perform Profiling (Call-Duration) based on MDC Data. See MDC Profiling, default false
• facility (Optional): Name of the Facility, default gelf-java
• additionalFields(number) (Optional): Post additional fields. Eg. fieldName=Value,field2=value2
• additionalFieldTypes (Optional): Type specification for additional and MDC fields. Supported types: String, long, Long, double, Double and discover (default if not specified, discover field type on parseability). Eg. field=String,field2=double
• mdcFields (Optional): Post additional fields, pull Values from MDC. Name of the Fields are comma-separated Application,Version,SomeOtherFieldName
• dynamicMdcFields (Optional): Dynamic MDC Fields allows you to extract MDC values based on one or more regular expressions. Multiple regex are comma-separated. The name of the MDC entry is used as GELF field name. mdc.*,[mdc|MDC]fields
• dynamicMdcFieldTypes (Optional): Pattern-based type specification for additional and MDC fields. Key-value pairs are comma-separated. Supported types: String, long, Long, double, Double. Eg. my_field.*=String,business\..*\.field=double
• includeFullMdc (Optional): Include all fields from the MDC, default false

MDC Profiling

MDC Profiling allows to calculate the runtime from request start up to the time until the log message was generated. You must set one value in the MDC:

• profiling.requestStart.millis: Time Millis of the Request-Start (Long or String)

Two values are set by the formatter:

• profiling.requestEnd: End-Time of the Request-End in Date.toString-representation
• profiling.requestDuration: Duration of the request (e.g. 205ms, 16sec)

Author:

Kai Geisselhardt, Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTI_VALUE_DELIMITTER
static Set<LogMessageField.NamedLogField>	SUPPORTED_FIELDS

Fields inherited from class org.apache.log4j.Layout

LINE_SEP, LINE_SEP_LEN

Constructor Summary

Constructors

Constructor and Description
GelfLayout()

Method Summary

Modifier and Type	Method and Description
void	activateOptions()
String	format(org.apache.log4j.spi.LoggingEvent loggingEvent)
String	getExtractStackTrace()
String	getFacility()
String	getLineBreak()
String	getOriginHost()
String	getTimestampPattern()
String	getVersion()
boolean	ignoresThrowable()
boolean	isFilterStackTrace()
boolean	isIncludeFullMdc()
boolean	isIncludeLocation()
boolean	isMdcProfiling()
void	setAdditionalFields(String spec)
void	setAdditionalFieldTypes(String spec)
void	setDynamicMdcFields(String spec)
void	setDynamicMdcFieldTypes(String spec)
void	setExtractStackTrace(String extractStacktrace)
void	setFacility(String facility)
void	setFields(String fieldSpec)
void	setFilterStackTrace(boolean filterStackTrace)
void	setIncludeFullMdc(boolean includeFullMdc)
void	setIncludeLocation(boolean includeLocation)
void	setLineBreak(String lineBreak)
void	setMdcFields(String spec)
void	setMdcProfiling(boolean mdcProfiling)
void	setOriginHost(String originHost)
void	setTimestampPattern(String timestampPattern)
void	setVersion(String version)

Methods inherited from class org.apache.log4j.Layout

getContentType, getFooter, getHeader

Methods inherited from class java.lang.Object

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

Field Detail

MULTI_VALUE_DELIMITTER

public static final String MULTI_VALUE_DELIMITTER

See Also:

Constant Field Values

SUPPORTED_FIELDS

public static final Set<LogMessageField.NamedLogField> SUPPORTED_FIELDS

Constructor Detail

GelfLayout

public GelfLayout()

Method Detail

format

public String format(org.apache.log4j.spi.LoggingEvent loggingEvent)

Specified by:

format in class org.apache.log4j.Layout

ignoresThrowable

public boolean ignoresThrowable()

Specified by:

ignoresThrowable in class org.apache.log4j.Layout

activateOptions

public void activateOptions()

setFields

public void setFields(String fieldSpec)

setAdditionalFields

public void setAdditionalFields(String spec)

setAdditionalFieldTypes

public void setAdditionalFieldTypes(String spec)

setMdcFields

public void setMdcFields(String spec)

setDynamicMdcFields

public void setDynamicMdcFields(String spec)

setDynamicMdcFieldTypes

public void setDynamicMdcFieldTypes(String spec)

isMdcProfiling

public boolean isMdcProfiling()

setMdcProfiling

public void setMdcProfiling(boolean mdcProfiling)

isIncludeFullMdc

public boolean isIncludeFullMdc()

setIncludeFullMdc

public void setIncludeFullMdc(boolean includeFullMdc)

getOriginHost

public String getOriginHost()

setOriginHost

public void setOriginHost(String originHost)

getFacility

public String getFacility()

setFacility

public void setFacility(String facility)

getExtractStackTrace

public String getExtractStackTrace()

setExtractStackTrace

public void setExtractStackTrace(String extractStacktrace)

isFilterStackTrace

public boolean isFilterStackTrace()

setFilterStackTrace

public void setFilterStackTrace(boolean filterStackTrace)

isIncludeLocation

public boolean isIncludeLocation()

setIncludeLocation

public void setIncludeLocation(boolean includeLocation)

getTimestampPattern

public String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(String timestampPattern)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getLineBreak

public String getLineBreak()

setLineBreak

public void setLineBreak(String lineBreak)