biz.paluch.logging.gelf.jul

Class GelfFormatter

java.lang.Object

java.util.logging.Formatter

biz.paluch.logging.gelf.jul.GelfFormatter

public class GelfFormatter
extends java.util.logging.Formatter

Log-Formatter for JSON using fields specified within GELF. This formatter will produce a JSON object for each log event. Example: { "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", "Time": "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
• 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
• includeLogMessageParameters (Optional): Include message parameters from the log event (see LogRecord.getParameters(), default true
• 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

Since:

1.14.0

Author:

Greg Peterson

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GelfFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.util.logging.LogRecord record)
java.lang.String	getExtractStackTrace()
java.lang.String	getFacility()
java.lang.String	getLineBreak()
java.lang.String	getOriginHost()
java.lang.String	getTimestampPattern()
java.lang.String	getVersion()
boolean	isFilterStackTrace()
boolean	isIncludeLocation()
boolean	isIncludeLogMessageParameters()
void	setAdditionalFields(java.lang.String spec)
void	setAdditionalFieldTypes(java.lang.String spec)
void	setExtractStackTrace(java.lang.String extractStacktrace)
void	setFacility(java.lang.String facility)
void	setFields(java.lang.String fieldSpec)
void	setFilterStackTrace(boolean filterStackTrace)
void	setIncludeLocation(boolean includeLocation)
void	setIncludeLogMessageParameters(boolean includeLogMessageParameters)
void	setLineBreak(java.lang.String lineBreak)
void	setOriginHost(java.lang.String originHost)
void	setTimestampPattern(java.lang.String timestampPattern)
void	setVersion(java.lang.String version)

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

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 java.lang.String MULTI_VALUE_DELIMITTER

See Also:

Constant Field Values

SUPPORTED_FIELDS

public static final java.util.Set<LogMessageField.NamedLogField> SUPPORTED_FIELDS

Constructor Detail

GelfFormatter

public GelfFormatter()

Method Detail

format

public java.lang.String format(java.util.logging.LogRecord record)

Specified by:

format in class java.util.logging.Formatter

setFields

public void setFields(java.lang.String fieldSpec)

setAdditionalFields

public void setAdditionalFields(java.lang.String spec)

setAdditionalFieldTypes

public void setAdditionalFieldTypes(java.lang.String spec)

getOriginHost

public java.lang.String getOriginHost()

setOriginHost

public void setOriginHost(java.lang.String originHost)

getFacility

public java.lang.String getFacility()

setFacility

public void setFacility(java.lang.String facility)

getExtractStackTrace

public java.lang.String getExtractStackTrace()

setExtractStackTrace

public void setExtractStackTrace(java.lang.String extractStacktrace)

isFilterStackTrace

public boolean isFilterStackTrace()

setFilterStackTrace

public void setFilterStackTrace(boolean filterStackTrace)

isIncludeLogMessageParameters

public boolean isIncludeLogMessageParameters()

setIncludeLogMessageParameters

public void setIncludeLogMessageParameters(boolean includeLogMessageParameters)

isIncludeLocation

public boolean isIncludeLocation()

setIncludeLocation

public void setIncludeLocation(boolean includeLocation)

getTimestampPattern

public java.lang.String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(java.lang.String timestampPattern)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getLineBreak

public java.lang.String getLineBreak()

setLineBreak

public void setLineBreak(java.lang.String lineBreak)