biz.paluch.logging.gelf

Class GelfMessageAssembler

java.lang.Object

biz.paluch.logging.gelf.GelfMessageAssembler

All Implemented Interfaces:

HostAndPortProvider

Direct Known Subclasses:

MdcGelfMessageAssembler

public class GelfMessageAssembler
extends Object
implements HostAndPortProvider

Creates GelfMessage based on various LogEvent. A LogEvent encapsulates log-framework specifics and exposes commonly used details of log events.

Since:

26.09.13 15:05

Author:

Mark Paluch, Thomas Herzog

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_MESSAGE_PARAM
static String	FIELD_STACK_TRACE
static String	PROPERTY_USE_POOLING Deprecated. see PoolingGelfMessageBuilder.PROPERTY_USE_POOLING.

Constructor Summary

Constructors

Constructor and Description
GelfMessageAssembler()

Method Summary

Modifier and Type	Method and Description
void	addField(MessageField field)
void	addFields(Collection<? extends MessageField> fields)
GelfMessage	createGelfMessage(LogEvent logEvent) Produce a GelfMessage.
String	getExtractStackTrace()
String	getFacility()
String	getHost()
int	getMaximumMessageSize()
String	getOriginHost()
int	getPort()
String	getTimestampPattern()
String	getVersion()
void	initialize(PropertyProvider propertyProvider) Initialize the GelfMessageAssembler from a property provider.
boolean	isExtractStackTrace()
boolean	isFilterStackTrace()
boolean	isIncludeLocation()
boolean	isIncludeLogMessageParameters()
void	setAdditionalFieldType(String field, String type)
void	setDynamicMdcFieldType(Pattern fieldPattern, String type)
void	setDynamicMdcFieldType(String fieldPattern, String type)
void	setExtractStackTrace(boolean extractStackTrace)
void	setExtractStackTrace(String value)
void	setFacility(String facility)
void	setFilterStackTrace(boolean filterStackTrace)
void	setHost(String host)
void	setIncludeLocation(boolean includeLocation)
void	setIncludeLogMessageParameters(boolean includeLogMessageParameters)
void	setMaximumMessageSize(int maximumMessageSize)
void	setOriginHost(String originHost)
void	setPort(int port)
void	setTimestampPattern(String timestampPattern)
void	setVersion(String version)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_USE_POOLING

@Deprecated
public static final String PROPERTY_USE_POOLING

Deprecated. see PoolingGelfMessageBuilder.PROPERTY_USE_POOLING.

See Also:

Constant Field Values

FIELD_MESSAGE_PARAM

public static final String FIELD_MESSAGE_PARAM

See Also:

Constant Field Values

FIELD_STACK_TRACE

public static final String FIELD_STACK_TRACE

See Also:

Constant Field Values

Constructor Detail

GelfMessageAssembler

public GelfMessageAssembler()

Method Detail

initialize

public void initialize(PropertyProvider propertyProvider)

Initialize the GelfMessageAssembler from a property provider.

Parameters:

propertyProvider - property provider to obtain configuration properties

createGelfMessage

public GelfMessage createGelfMessage(LogEvent logEvent)

Produce a GelfMessage.

Parameters:

logEvent - the log event

Returns:

a new GelfMessage

setAdditionalFieldType

public void setAdditionalFieldType(String field,
                                   String type)

setDynamicMdcFieldType

public void setDynamicMdcFieldType(String fieldPattern,
                                   String type)

setDynamicMdcFieldType

public void setDynamicMdcFieldType(Pattern fieldPattern,
                                   String type)

addField

public void addField(MessageField field)

addFields

public void addFields(Collection<? extends MessageField> fields)

getHost

public String getHost()

Specified by:

getHost in interface HostAndPortProvider

Returns:

the host.

setHost

public void setHost(String host)

getOriginHost

public String getOriginHost()

setOriginHost

public void setOriginHost(String originHost)

getPort

public int getPort()

Specified by:

getPort in interface HostAndPortProvider

Returns:

the port number.

setPort

public void setPort(int port)

getFacility

public String getFacility()

setFacility

public void setFacility(String facility)

isExtractStackTrace

public boolean isExtractStackTrace()

getExtractStackTrace

public String getExtractStackTrace()

setExtractStackTrace

public void setExtractStackTrace(boolean extractStackTrace)

setExtractStackTrace

public void setExtractStackTrace(String value)

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 String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(String timestampPattern)

getMaximumMessageSize

public int getMaximumMessageSize()

setMaximumMessageSize

public void setMaximumMessageSize(int maximumMessageSize)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)