biz.paluch.logging.gelf.jul

Class GelfLogHandler

java.lang.Object

java.util.logging.Handler

biz.paluch.logging.gelf.jul.GelfLogHandler

All Implemented Interfaces:

ErrorReporter

Direct Known Subclasses:

JBoss7GelfLogHandler, WildFlyGelfLogHandler

public class GelfLogHandler
extends java.util.logging.Handler
implements ErrorReporter

Logging-Handler for GELF (Graylog Extended Logging Format). This Java-Util-Logging Handler creates GELF Messages and posts them using UDP (default) or TCP. Following parameters are supported/needed:

• host (Mandatory): Hostname/IP-Address of the Logstash Host
  • (the host) for UDP, e.g. 127.0.0.1 or some.host.com
  • See docs for more details
• port (Optional): Port, default 12201
• version (Optional): GELF Version 1.0 or 1.1, default 1.0
• 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
• includeLogMessageParameters (Optional): Include message parameters from the log event (see LogRecord.getParameters(), default true
• 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
• level (Optional): Log-Level, default INFO
• filter (Optional): Class-Name of a Log-Filter, default none
• additionalField.(number) (Optional): Post additional fields. Eg. .GelfLogHandler.additionalField.0=fieldName=Value

The publish(LogRecord) method is thread-safe and may be called by different threads at any time.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
protected GelfMessageAssembler	gelfMessageAssembler
protected GelfSender	gelfSender

Constructor Summary

Constructors

Constructor and Description
GelfLogHandler()

Method Summary

Modifier and Type	Method and Description
void	close()
protected GelfMessage	createGelfMessage(java.util.logging.LogRecord record)
protected GelfMessageAssembler	createGelfMessageAssembler()
protected GelfSender	createGelfSender()
void	flush()
java.lang.String	getExtractStackTrace()
java.lang.String	getFacility()
java.lang.String	getGraylogHost()
int	getGraylogPort()
java.lang.String	getHost()
int	getMaximumMessageSize()
java.lang.String	getOriginHost()
int	getPort()
java.lang.String	getTimestampPattern()
java.lang.String	getVersion()
protected void	initializeDefaultFields()
boolean	isFilterStackTrace()
boolean	isIncludeLocation()
boolean	isIncludeLogMessageParameters()
void	publish(java.util.logging.LogRecord record)
void	reportError(java.lang.String message, java.lang.Exception e) Report an error caused by a exception.
void	setAdditionalFields(java.lang.String spec)
void	setAdditionalFieldTypes(java.lang.String spec)
void	setDynamicMdcFields(java.lang.String spec)
void	setDynamicMdcFieldTypes(java.lang.String spec)
void	setExtractStackTrace(java.lang.String extractStacktrace)
void	setFacility(java.lang.String facility)
void	setFilterStackTrace(boolean filterStackTrace)
void	setGraylogHost(java.lang.String graylogHost)
void	setGraylogPort(int graylogPort)
void	setHost(java.lang.String host)
void	setIncludeLocation(boolean includeLocation)
void	setIncludeLogMessageParameters(boolean includeLogMessageParameters)
void	setMaximumMessageSize(int maximumMessageSize)
void	setMdcFields(java.lang.String spec)
void	setOriginHost(java.lang.String originHost)
void	setPort(int port)
void	setTimestampPattern(java.lang.String timestampPattern)
void	setVersion(java.lang.String version)

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

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

Field Detail

gelfSender

protected volatile GelfSender gelfSender

gelfMessageAssembler

protected GelfMessageAssembler gelfMessageAssembler

Constructor Detail

GelfLogHandler

public GelfLogHandler()

Method Detail

initializeDefaultFields

protected void initializeDefaultFields()

createGelfMessageAssembler

protected GelfMessageAssembler createGelfMessageAssembler()

flush

public void flush()

Specified by:

flush in class java.util.logging.Handler

publish

public void publish(java.util.logging.LogRecord record)

Specified by:

publish in class java.util.logging.Handler

createGelfSender

protected GelfSender createGelfSender()

reportError

public void reportError(java.lang.String message,
                        java.lang.Exception e)

Description copied from interface: ErrorReporter

Report an error caused by a exception.

Specified by:

reportError in interface ErrorReporter

Parameters:

message - the message

e - the exception

close

public void close()

Specified by:

close in class java.util.logging.Handler

createGelfMessage

protected GelfMessage createGelfMessage(java.util.logging.LogRecord record)

setAdditionalFields

public void setAdditionalFields(java.lang.String spec)

setAdditionalFieldTypes

public void setAdditionalFieldTypes(java.lang.String spec)

setMdcFields

public void setMdcFields(java.lang.String spec)

setDynamicMdcFields

public void setDynamicMdcFields(java.lang.String spec)

setDynamicMdcFieldTypes

public void setDynamicMdcFieldTypes(java.lang.String spec)

getGraylogHost

public java.lang.String getGraylogHost()

setGraylogHost

public void setGraylogHost(java.lang.String graylogHost)

getOriginHost

public java.lang.String getOriginHost()

setOriginHost

public void setOriginHost(java.lang.String originHost)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getGraylogPort

public int getGraylogPort()

setGraylogPort

public void setGraylogPort(int graylogPort)

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)

getMaximumMessageSize

public int getMaximumMessageSize()

setMaximumMessageSize

public void setMaximumMessageSize(int maximumMessageSize)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)