biz.paluch.logging.gelf.intern

Class GelfMessage

java.lang.Object

biz.paluch.logging.gelf.intern.GelfMessage

public class GelfMessage
extends java.lang.Object

Represents a Gelf message. A Gelf message contains all required Fields according to the Gelf Spec. A GelfMessage can be converted to toJson(), to toTCPBuffer() and to toUDPBuffers(). It also provides methods accepting ByteBuffer to reduce GC pressure.

Author:

https://github.com/t0xa/gelfj, Mark Paluch, Thomas Herzog, Daniel Lundsgaard Skovenborg

See Also:

http://docs.graylog.org/en/2.0/pages/gelf.html

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAUL_LEVEL
static java.lang.String	DEFAULT_FACILITY
static int	DEFAULT_MESSAGE_SIZE
static java.lang.String	FIELD_FACILITY
static java.lang.String	FIELD_FULL_MESSAGE
static java.lang.String	FIELD_HOST
static java.lang.String	FIELD_LEVEL
static java.lang.String	FIELD_SHORT_MESSAGE
static java.lang.String	FIELD_TIMESTAMP
static java.lang.String	FIELD_TYPE_DEFAULT
static java.lang.String	FIELD_TYPE_DISCOVER Discover the field type by trying to parse it.
static java.lang.String	FIELD_TYPE_DOUBLE double field type.
static java.lang.String	FIELD_TYPE_DOUBLE2 Double field type.
static java.lang.String	FIELD_TYPE_LONG long field type.
static java.lang.String	FIELD_TYPE_LONG2 Long field type.
static java.lang.String	FIELD_TYPE_STRING String field type.
static java.lang.String	GELF_VERSION
static java.lang.String	GELF_VERSION_1_0
static java.lang.String	GELF_VERSION_1_1
static java.lang.String	ID_NAME

Constructor Summary

Constructors

Constructor and Description
GelfMessage()
GelfMessage(java.lang.String shortMessage, java.lang.String fullMessage, long timestamp, java.lang.String level)

Method Summary

Modifier and Type	Method and Description
GelfMessage	addField(java.lang.String key, java.lang.String value) Add a particular field.
GelfMessage	addFields(java.util.Map<java.lang.String,java.lang.String> fields) Add multiple fields (key/value pairs)
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.String>	getAdditionalFieldTypes()
java.util.Map<java.lang.String,java.lang.String>	getAdditonalFields()
java.lang.String	getFacility()
java.lang.String	getField(java.lang.String fieldName)
java.lang.String	getFullMessage()
java.lang.String	getHost()
java.lang.Long	getJavaTimestamp()
java.lang.String	getLevel()
int	getMaximumMessageSize()
java.lang.String	getShortMessage()
java.lang.String	getTimestamp()
java.math.BigDecimal	getTimestampAsBigDecimal()
java.lang.String	getVersion()
int	hashCode()
static boolean	isEmpty(java.lang.String str)
boolean	isValid()
void	setAdditionalFieldTypes(java.util.Map<java.lang.String,java.lang.String> additionalFieldTypes)
void	setDynamicMdcFieldTypes(java.util.Map<java.util.regex.Pattern,java.lang.String> dynamicMdcFieldTypes)
void	setFacility(java.lang.String facility)
void	setFullMessage(java.lang.String fullMessage)
void	setHost(java.lang.String host)
void	setJavaTimestamp(long javaTimestamp)
void	setLevel(java.lang.String level)
void	setMaximumMessageSize(int maximumMessageSize)
void	setShortMessage(java.lang.String shortMessage)
void	setVersion(java.lang.String version)
protected java.nio.ByteBuffer[]	sliceDatagrams(java.nio.ByteBuffer source, int datagrams, java.nio.ByteBuffer target)
java.lang.String	toJson() Create a JSON representation for this GelfMessage.
void	toJson(java.nio.ByteBuffer byteBuffer, java.lang.String additionalFieldPrefix) Create a JSON representation for this GelfMessage and write it to the ByteBuffer.
protected void	toJson(biz.paluch.logging.gelf.intern.OutputAccessor out, java.lang.String additionalFieldPrefix)
java.lang.String	toJson(java.lang.String additionalFieldPrefix) Create a JSON representation for this GelfMessage.
java.nio.ByteBuffer	toTCPBuffer()
java.nio.ByteBuffer	toTCPBuffer(java.nio.ByteBuffer buffer)
java.nio.ByteBuffer[]	toUDPBuffers()
java.nio.ByteBuffer[]	toUDPBuffers(java.nio.ByteBuffer buffer, java.nio.ByteBuffer tempBuffer)

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_HOST

public static final java.lang.String FIELD_HOST

See Also:

Constant Field Values

FIELD_SHORT_MESSAGE

public static final java.lang.String FIELD_SHORT_MESSAGE

See Also:

Constant Field Values

FIELD_FULL_MESSAGE

public static final java.lang.String FIELD_FULL_MESSAGE

See Also:

Constant Field Values

FIELD_TIMESTAMP

public static final java.lang.String FIELD_TIMESTAMP

See Also:

Constant Field Values

FIELD_LEVEL

public static final java.lang.String FIELD_LEVEL

See Also:

Constant Field Values

FIELD_FACILITY

public static final java.lang.String FIELD_FACILITY

See Also:

Constant Field Values

ID_NAME

public static final java.lang.String ID_NAME

See Also:

Constant Field Values

FIELD_TYPE_DISCOVER

public static final java.lang.String FIELD_TYPE_DISCOVER

Discover the field type by trying to parse it.

See Also:

Constant Field Values

FIELD_TYPE_STRING

public static final java.lang.String FIELD_TYPE_STRING

String field type.

See Also:

Constant Field Values

FIELD_TYPE_LONG

public static final java.lang.String FIELD_TYPE_LONG

long field type. Zero if value cannot be converted.

See Also:

Constant Field Values

FIELD_TYPE_LONG2

public static final java.lang.String FIELD_TYPE_LONG2

Long field type. Null if value cannot be converted.

See Also:

Constant Field Values

FIELD_TYPE_DOUBLE

public static final java.lang.String FIELD_TYPE_DOUBLE

double field type. Zero if value cannot be converted.

See Also:

Constant Field Values

FIELD_TYPE_DOUBLE2

public static final java.lang.String FIELD_TYPE_DOUBLE2

Double field type. Null if value cannot be converted.

See Also:

Constant Field Values

FIELD_TYPE_DEFAULT

public static final java.lang.String FIELD_TYPE_DEFAULT

See Also:

Constant Field Values

GELF_VERSION_1_0

public static final java.lang.String GELF_VERSION_1_0

See Also:

Constant Field Values

GELF_VERSION_1_1

public static final java.lang.String GELF_VERSION_1_1

See Also:

Constant Field Values

GELF_VERSION

public static final java.lang.String GELF_VERSION

See Also:

Constant Field Values

DEFAULT_FACILITY

public static final java.lang.String DEFAULT_FACILITY

See Also:

Constant Field Values

DEFAULT_MESSAGE_SIZE

public static final int DEFAULT_MESSAGE_SIZE

See Also:

Constant Field Values

DEFAUL_LEVEL

public static final int DEFAUL_LEVEL

See Also:

Constant Field Values

Constructor Detail

GelfMessage

public GelfMessage()

GelfMessage

public GelfMessage(java.lang.String shortMessage,
                   java.lang.String fullMessage,
                   long timestamp,
                   java.lang.String level)

Method Detail

toJson

public java.lang.String toJson()

Create a JSON representation for this GelfMessage. Additional fields are prefixed with underscore _.

Returns:

the JSON string.

toJson

public java.lang.String toJson(java.lang.String additionalFieldPrefix)

Create a JSON representation for this GelfMessage. Additional fields are prefixed with additionalFieldPrefix.

Parameters:

additionalFieldPrefix - must not be null

Returns:

the JSON string.

toJson

public void toJson(java.nio.ByteBuffer byteBuffer,
                   java.lang.String additionalFieldPrefix)

Create a JSON representation for this GelfMessage and write it to the ByteBuffer. Additional fields are prefixed with additionalFieldPrefix.

Parameters:

byteBuffer - must not be null

additionalFieldPrefix - must not be null

toJson

protected void toJson(biz.paluch.logging.gelf.intern.OutputAccessor out,
                      java.lang.String additionalFieldPrefix)

toUDPBuffers

public java.nio.ByteBuffer[] toUDPBuffers()

toUDPBuffers

public java.nio.ByteBuffer[] toUDPBuffers(java.nio.ByteBuffer buffer,
                                          java.nio.ByteBuffer tempBuffer)

toTCPBuffer

public java.nio.ByteBuffer toTCPBuffer()

toTCPBuffer

public java.nio.ByteBuffer toTCPBuffer(java.nio.ByteBuffer buffer)

sliceDatagrams

protected java.nio.ByteBuffer[] sliceDatagrams(java.nio.ByteBuffer source,
                                               int datagrams,
                                               java.nio.ByteBuffer target)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getShortMessage

public java.lang.String getShortMessage()

setShortMessage

public void setShortMessage(java.lang.String shortMessage)

getFullMessage

public java.lang.String getFullMessage()

setFullMessage

public void setFullMessage(java.lang.String fullMessage)

getTimestampAsBigDecimal

public java.math.BigDecimal getTimestampAsBigDecimal()

getTimestamp

public java.lang.String getTimestamp()

getJavaTimestamp

public java.lang.Long getJavaTimestamp()

setJavaTimestamp

public void setJavaTimestamp(long javaTimestamp)

getLevel

public java.lang.String getLevel()

setLevel

public void setLevel(java.lang.String level)

getFacility

public java.lang.String getFacility()

setFacility

public void setFacility(java.lang.String facility)

getAdditionalFieldTypes

public java.util.Map<java.lang.String,java.lang.String> getAdditionalFieldTypes()

setAdditionalFieldTypes

public void setAdditionalFieldTypes(java.util.Map<java.lang.String,java.lang.String> additionalFieldTypes)

setDynamicMdcFieldTypes

public void setDynamicMdcFieldTypes(java.util.Map<java.util.regex.Pattern,java.lang.String> dynamicMdcFieldTypes)

addFields

public GelfMessage addFields(java.util.Map<java.lang.String,java.lang.String> fields)

Add multiple fields (key/value pairs)

Parameters:

fields - map of fields

Returns:

the current GelfMessage.

addField

public GelfMessage addField(java.lang.String key,
                            java.lang.String value)

Add a particular field.

Parameters:

key - the key

value - the value

Returns:

the current GelfMessage.

getAdditonalFields

public java.util.Map<java.lang.String,java.lang.String> getAdditonalFields()

isValid

public boolean isValid()

isEmpty

public static boolean isEmpty(java.lang.String str)

getMaximumMessageSize

public int getMaximumMessageSize()

setMaximumMessageSize

public void setMaximumMessageSize(int maximumMessageSize)

getField

public java.lang.String getField(java.lang.String fieldName)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object