biz.paluch.logging.gelf.logback

Class GelfLogbackAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

biz.paluch.logging.gelf.logback.GelfLogbackAppender

All Implemented Interfaces:

ErrorReporter, ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle

public class GelfLogbackAppender
extends ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>
implements ErrorReporter

Logging-Handler for GELF (Graylog Extended Logging Format). This Logback 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
• 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
• filter (Optional): logback filter (incl. log level)
• additionalFields(number) (Optional): Post additional fields. Eg. .GelfLogHandler.additionalFields=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 mdcFields=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.
• 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 Log Appender:

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

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

Since:

2013-10-08

Author:

Tobias Kaefer

Field Summary

Fields

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

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

name, started

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

context

Constructor Summary

Constructors

Constructor and Description
GelfLogbackAppender()

Method Summary

Modifier and Type	Method and Description
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent event)
protected GelfMessage	createGelfMessage(ch.qos.logback.classic.spi.ILoggingEvent loggingEvent)
protected GelfSender	createGelfSender()
String	getExtractStackTrace()
String	getFacility()
String	getGraylogHost()
int	getGraylogPort()
String	getHost()
int	getMaximumMessageSize()
String	getOriginHost()
int	getPort()
String	getTimestampPattern()
String	getVersion()
boolean	isFilterStackTrace()
boolean	isIncludeFullMdc()
boolean	isIncludeLocation()
boolean	isMdcProfiling()
void	reportError(String message, Exception exception) Report an error caused by a exception.
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	setFilterStackTrace(boolean filterStackTrace)
void	setGraylogHost(String graylogHost)
void	setGraylogPort(int graylogPort)
void	setHost(String host)
void	setIncludeFullMdc(boolean includeFullMdc)
void	setIncludeLocation(boolean includeLocation)
void	setMaximumMessageSize(int maximumMessageSize)
void	setMdcFields(String spec)
void	setMdcProfiling(boolean mdcProfiling)
void	setOriginHost(String originHost)
void	setPort(int port)
void	setTimestampPattern(String timestampPattern)
void	setVersion(String version)
void	start()
void	stop()

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

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

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, wait, wait, wait

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

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

Field Detail

gelfSender

protected GelfSender gelfSender

gelfMessageAssembler

protected MdcGelfMessageAssembler gelfMessageAssembler

Constructor Detail

GelfLogbackAppender

public GelfLogbackAppender()

Method Detail

append

protected void append(ch.qos.logback.classic.spi.ILoggingEvent event)

Specified by:

append in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

start

public void start()

Specified by:

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

Overrides:

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

stop

public void stop()

Specified by:

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

Overrides:

stop in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

createGelfSender

protected GelfSender createGelfSender()

reportError

public void reportError(String message,
                        Exception exception)

Description copied from interface: ErrorReporter

Report an error caused by a exception.

Specified by:

reportError in interface ErrorReporter

Parameters:

message - the message

exception - the exception

createGelfMessage

protected GelfMessage createGelfMessage(ch.qos.logback.classic.spi.ILoggingEvent loggingEvent)

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)

getGraylogHost

public String getGraylogHost()

setGraylogHost

public void setGraylogHost(String graylogHost)

getOriginHost

public String getOriginHost()

setOriginHost

public void setOriginHost(String originHost)

getGraylogPort

public int getGraylogPort()

setGraylogPort

public void setGraylogPort(int graylogPort)

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

setPort

public void setPort(int port)

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)

isMdcProfiling

public boolean isMdcProfiling()

setMdcProfiling

public void setMdcProfiling(boolean mdcProfiling)

getTimestampPattern

public String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(String timestampPattern)

getMaximumMessageSize

public int getMaximumMessageSize()

setMaximumMessageSize

public void setMaximumMessageSize(int maximumMessageSize)

isIncludeFullMdc

public boolean isIncludeFullMdc()

setIncludeFullMdc

public void setIncludeFullMdc(boolean includeFullMdc)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)