biz.paluch.logging.gelf

Class GelfMessageBuilder

java.lang.Object

biz.paluch.logging.gelf.GelfMessageBuilder

Direct Known Subclasses:

PoolingGelfMessageBuilder

public class GelfMessageBuilder
extends java.lang.Object

Builder to create a GelfMessage.

Since:

18.07.14 20:52

Author:

Mark Paluch, Thomas Herzog

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	additionalFields
protected java.util.Map<java.lang.String,java.lang.String>	additionalFieldTypes
protected java.util.Map<java.util.regex.Pattern,java.lang.String>	dynamicMdcFieldTypes
protected java.lang.String	facility
protected java.lang.String	fullMessage
protected java.lang.String	host
protected long	javaTimestamp
protected java.lang.String	level
protected int	maximumMessageSize
protected java.lang.String	shortMessage
protected java.lang.String	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GelfMessageBuilder()

Method Summary

Modifier and Type	Method and Description
GelfMessage	build() Build a new Gelf message based on the builder settings.
static GelfMessageBuilder	newInstance() Creates a new instance of the GelfMessageBuilder.
GelfMessageBuilder	withAdditionalFieldTypes(java.util.Map<java.lang.String,java.lang.String> additionalFieldTypes) Set additional field types
GelfMessageBuilder	withDynamicMdcFieldTypes(java.util.Map<java.util.regex.Pattern,java.lang.String> dynamicMdcFieldTypes) Set dynamic mdc field types
GelfMessageBuilder	withFacility(java.lang.String facility) Set the facility.
GelfMessageBuilder	withField(java.lang.String key, java.lang.String value) Add an additional field.
GelfMessageBuilder	withFields(java.util.Map<java.lang.String,java.lang.String> additionalFields) Add additional fields.
GelfMessageBuilder	withFullMessage(java.lang.String fullMessage) Set the full_message.
GelfMessageBuilder	withHost(java.lang.String host) Set the host.
GelfMessageBuilder	withJavaTimestamp(long javaTimestamp) Set the java timestamp (millis).
GelfMessageBuilder	withLevel(java.lang.String level) Set the level (severity).
GelfMessageBuilder	withMaximumMessageSize(int maximumMessageSize) Set the max message size.
GelfMessageBuilder	withShortMessage(java.lang.String shortMessage) Set the short_message.
GelfMessageBuilder	withVersion(java.lang.String version) Set the version.

Methods inherited from class java.lang.Object

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

Field Detail

version

protected java.lang.String version

host

protected java.lang.String host

shortMessage

protected java.lang.String shortMessage

fullMessage

protected java.lang.String fullMessage

javaTimestamp

protected long javaTimestamp

level

protected java.lang.String level

facility

protected java.lang.String facility

maximumMessageSize

protected int maximumMessageSize

additionalFields

protected java.util.Map<java.lang.String,java.lang.String> additionalFields

additionalFieldTypes

protected java.util.Map<java.lang.String,java.lang.String> additionalFieldTypes

dynamicMdcFieldTypes

protected java.util.Map<java.util.regex.Pattern,java.lang.String> dynamicMdcFieldTypes

Constructor Detail

GelfMessageBuilder

protected GelfMessageBuilder()

Method Detail

newInstance

public static GelfMessageBuilder newInstance()

Creates a new instance of the GelfMessageBuilder.

Returns:

GelfMessageBuilder

withVersion

public GelfMessageBuilder withVersion(java.lang.String version)

Set the version.

Parameters:

version - the version

Returns:

GelfMessageBuilder

withHost

public GelfMessageBuilder withHost(java.lang.String host)

Set the host.

Parameters:

host - the host

Returns:

GelfMessageBuilder

withShortMessage

public GelfMessageBuilder withShortMessage(java.lang.String shortMessage)

Set the short_message.

Parameters:

shortMessage - the short_message

Returns:

GelfMessageBuilder

withFullMessage

public GelfMessageBuilder withFullMessage(java.lang.String fullMessage)

Set the full_message.

Parameters:

fullMessage - the fullMessage

Returns:

GelfMessageBuilder

withLevel

public GelfMessageBuilder withLevel(java.lang.String level)

Set the level (severity).

Parameters:

level - the level

Returns:

GelfMessageBuilder

withFacility

public GelfMessageBuilder withFacility(java.lang.String facility)

Set the facility.

Parameters:

facility - the facility

Returns:

GelfMessageBuilder

withMaximumMessageSize

public GelfMessageBuilder withMaximumMessageSize(int maximumMessageSize)

Set the max message size.

Parameters:

maximumMessageSize - the maximumMessageSize

Returns:

GelfMessageBuilder

withJavaTimestamp

public GelfMessageBuilder withJavaTimestamp(long javaTimestamp)

Set the java timestamp (millis).

Parameters:

javaTimestamp - the javaTimestamp

Returns:

GelfMessageBuilder

withFields

public GelfMessageBuilder withFields(java.util.Map<java.lang.String,java.lang.String> additionalFields)

Add additional fields.

Parameters:

additionalFields - the additionalFields

Returns:

GelfMessageBuilder

withField

public GelfMessageBuilder withField(java.lang.String key,
                                    java.lang.String value)

Add an additional field.

Parameters:

key - the key

value - the value

Returns:

GelfMessageBuilder

withAdditionalFieldTypes

public GelfMessageBuilder withAdditionalFieldTypes(java.util.Map<java.lang.String,java.lang.String> additionalFieldTypes)

Set additional field types

Parameters:

additionalFieldTypes - the type map

Returns:

GelfMessageBuilder

withDynamicMdcFieldTypes

public GelfMessageBuilder withDynamicMdcFieldTypes(java.util.Map<java.util.regex.Pattern,java.lang.String> dynamicMdcFieldTypes)

Set dynamic mdc field types

Parameters:

dynamicMdcFieldTypes - the type map

Returns:

GelfMessageBuilder

build

public GelfMessage build()

Build a new Gelf message based on the builder settings.

Returns:

GelfMessage