biz.paluch.logging.gelf.jboss7

Class JBoss7GelfLogHandler

java.lang.Object

java.util.logging.Handler

biz.paluch.logging.gelf.jul.GelfLogHandler

biz.paluch.logging.gelf.jboss7.JBoss7GelfLogHandler

All Implemented Interfaces:

ErrorReporter

public class JBoss7GelfLogHandler
extends GelfLogHandler

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
• enabled (Optional): Whether this handler is enabled, default true
• port (Optional): Port, default 12201
• 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
• 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
• 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 .JBoss7GelfLogHandler.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. .JBoss7GelfLogHandler.dynamicMdcFields=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 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 publish(LogRecord) method is thread-safe and may be called by different threads at any time.

Author:

Mark Paluch

Field Summary

Fields inherited from class biz.paluch.logging.gelf.jul.GelfLogHandler

gelfMessageAssembler, gelfSender

Constructor Summary

Constructors

Constructor and Description
JBoss7GelfLogHandler()

Method Summary

Modifier and Type	Method and Description
protected GelfMessage	createGelfMessage(LogRecord record)
protected GelfMessageAssembler	createGelfMessageAssembler()
protected void	initializeDefaultFields()
boolean	isEnabled()
boolean	isIncludeFullMdc()
boolean	isLoggable(LogRecord record)
boolean	isMdcProfiling()
void	publish(LogRecord record)
void	setEnabled(boolean enabled) Manually enable/disable the handler.
void	setIncludeFullMdc(boolean includeFullMdc)
void	setMdcProfiling(boolean mdcProfiling)

Methods inherited from class biz.paluch.logging.gelf.jul.GelfLogHandler

close, createGelfSender, flush, getExtractStackTrace, getFacility, getGraylogHost, getGraylogPort, getHost, getMaximumMessageSize, getOriginHost, getPort, getTimestampPattern, getVersion, isFilterStackTrace, isIncludeLocation, isIncludeLogMessageParameters, reportError, setAdditionalFields, setAdditionalFieldTypes, setDynamicMdcFields, setDynamicMdcFieldTypes, setExtractStackTrace, setFacility, setFilterStackTrace, setGraylogHost, setGraylogPort, setHost, setIncludeLocation, setIncludeLogMessageParameters, setMaximumMessageSize, setMdcFields, setOriginHost, setPort, setTimestampPattern, setVersion

Methods inherited from class java.util.logging.Handler

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JBoss7GelfLogHandler

public JBoss7GelfLogHandler()

Method Detail

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

Manually enable/disable the handler. This is also called by wildfly logger setup routines on server-startup with the value of the "enabled" attribute of <custom-handler>.

Parameters:

enabled - false to disable this handler.

initializeDefaultFields

protected void initializeDefaultFields()

Overrides:

initializeDefaultFields in class GelfLogHandler

isLoggable

public boolean isLoggable(LogRecord record)

Overrides:

isLoggable in class Handler

publish

public void publish(LogRecord record)

Overrides:

publish in class GelfLogHandler

createGelfMessageAssembler

protected GelfMessageAssembler createGelfMessageAssembler()

Overrides:

createGelfMessageAssembler in class GelfLogHandler

createGelfMessage

protected GelfMessage createGelfMessage(LogRecord record)

Overrides:

createGelfMessage in class GelfLogHandler

isMdcProfiling

public boolean isMdcProfiling()

setMdcProfiling

public void setMdcProfiling(boolean mdcProfiling)

isIncludeFullMdc

public boolean isIncludeFullMdc()

setIncludeFullMdc

public void setIncludeFullMdc(boolean includeFullMdc)