GelfMessage (logstash logging connectors 1.15.2-SNAPSHOT API)

java.lang.Object
- biz.paluch.logging.gelf.intern.GelfMessage

```
public class GelfMessage
extends 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 String`	`DEFAULT_FACILITY`
`static int`	`DEFAULT_MESSAGE_SIZE`
`static String`	`FIELD_FACILITY`
`static String`	`FIELD_FULL_MESSAGE`
`static String`	`FIELD_HOST`
`static String`	`FIELD_LEVEL`
`static String`	`FIELD_SHORT_MESSAGE`
`static String`	`FIELD_TIMESTAMP`
`static String`	`FIELD_TYPE_DEFAULT`
`static String`	`FIELD_TYPE_DISCOVER` Discover the field type by trying to parse it.
`static String`	`FIELD_TYPE_DOUBLE` double field type.
`static String`	`FIELD_TYPE_DOUBLE2` Double field type.
`static String`	`FIELD_TYPE_LONG` long field type.
`static String`	`FIELD_TYPE_LONG2` Long field type.
`static String`	`FIELD_TYPE_STRING` String field type.
`static String`	`FIELD_VERSION`
`static String`	`GELF_VERSION`
`static String`	`GELF_VERSION_1_0`
`static String`	`GELF_VERSION_1_1`
`static String`	`ID_NAME`

Constructor Summary

Constructors
Constructor and Description

GelfMessage()

GelfMessage(String shortMessage, String fullMessage, long timestamp, String level)

Constructors
Constructor and Description
`GelfMessage()`
`GelfMessage(String shortMessage, String fullMessage, long timestamp, String level)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GelfMessage`	`addField(String key, String value)` Add a particular field.
`GelfMessage`	`addFields(Map<String,String> fields)` Add multiple fields (key/value pairs)
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAdditionalFieldTypes()`
`Map<String,String>`	`getAdditonalFields()`
`String`	`getFacility()`
`String`	`getField(String fieldName)`
`String`	`getFullMessage()`
`String`	`getHost()`
`Long`	`getJavaTimestamp()`
`String`	`getLevel()`
`int`	`getMaximumMessageSize()`
`String`	`getShortMessage()`
`String`	`getTimestamp()`
`BigDecimal`	`getTimestampAsBigDecimal()`
`String`	`getVersion()`
`int`	`hashCode()`
`static boolean`	`isEmpty(String str)`
`boolean`	`isValid()`
`void`	`setAdditionalFieldTypes(Map<String,String> additionalFieldTypes)`
`void`	`setDynamicMdcFieldTypes(Map<Pattern,String> dynamicMdcFieldTypes)`
`void`	`setFacility(String facility)`
`void`	`setFullMessage(String fullMessage)`
`void`	`setHost(String host)`
`void`	`setJavaTimestamp(long javaTimestamp)`
`void`	`setLevel(String level)`
`void`	`setMaximumMessageSize(int maximumMessageSize)`
`void`	`setShortMessage(String shortMessage)`
`void`	`setVersion(String version)`
`protected ByteBuffer[]`	`sliceDatagrams(ByteBuffer source, int datagrams, ByteBuffer target)`
`String`	`toJson()` Create a JSON representation for this `GelfMessage`.
`void`	`toJson(ByteBuffer byteBuffer, 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, String additionalFieldPrefix)`
`String`	`toJson(String additionalFieldPrefix)` Create a JSON representation for this `GelfMessage`.
`ByteBuffer`	`toTCPBuffer()`
`ByteBuffer`	`toTCPBuffer(ByteBuffer buffer)`
`ByteBuffer[]`	`toUDPBuffers()`
`ByteBuffer[]`	`toUDPBuffers(ByteBuffer buffer, 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 String FIELD_HOST
```
  See Also:
  
  Constant Field Values
- FIELD_SHORT_MESSAGE
```
public static final String FIELD_SHORT_MESSAGE
```
  See Also:
  
  Constant Field Values
- FIELD_FULL_MESSAGE
```
public static final String FIELD_FULL_MESSAGE
```
  See Also:
  
  Constant Field Values
- FIELD_TIMESTAMP
```
public static final String FIELD_TIMESTAMP
```
  See Also:
  
  Constant Field Values
- FIELD_LEVEL
```
public static final String FIELD_LEVEL
```
  See Also:
  
  Constant Field Values
- FIELD_FACILITY
```
public static final String FIELD_FACILITY
```
  See Also:
  
  Constant Field Values
- FIELD_VERSION
```
public static final String FIELD_VERSION
```
  See Also:
  
  Constant Field Values
- ID_NAME
```
public static final String ID_NAME
```
  See Also:
  
  Constant Field Values
- FIELD_TYPE_DISCOVER
```
public static final String FIELD_TYPE_DISCOVER
```
  Discover the field type by trying to parse it.
  
  See Also:
  
  Constant Field Values
- FIELD_TYPE_STRING
```
public static final String FIELD_TYPE_STRING
```
  String field type.
  
  See Also:
  
  Constant Field Values
- FIELD_TYPE_LONG
```
public static final String FIELD_TYPE_LONG
```
  long field type. Zero if value cannot be converted.
  
  See Also:
  
  Constant Field Values
- FIELD_TYPE_LONG2
```
public static final String FIELD_TYPE_LONG2
```
  Long field type. Null if value cannot be converted.
  
  See Also:
  
  Constant Field Values
- FIELD_TYPE_DOUBLE
```
public static final String FIELD_TYPE_DOUBLE
```
  double field type. Zero if value cannot be converted.
  
  See Also:
  
  Constant Field Values
- FIELD_TYPE_DOUBLE2
```
public static final String FIELD_TYPE_DOUBLE2
```
  Double field type. Null if value cannot be converted.
  
  See Also:
  
  Constant Field Values
- FIELD_TYPE_DEFAULT
```
public static final String FIELD_TYPE_DEFAULT
```
  See Also:
  
  Constant Field Values
- GELF_VERSION_1_0
```
public static final String GELF_VERSION_1_0
```
  See Also:
  
  Constant Field Values
- GELF_VERSION_1_1
```
public static final String GELF_VERSION_1_1
```
  See Also:
  
  Constant Field Values
- GELF_VERSION
```
public static final String GELF_VERSION
```
  See Also:
  
  Constant Field Values
- DEFAULT_FACILITY
```
public static final 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(String shortMessage,
                   String fullMessage,
                   long timestamp,
                   String level)

Method Detail

toJson
```
public String toJson()
```
Create a JSON representation for this GelfMessage. Additional fields are prefixed with underscore _.

Returns:

the JSON string.

toJson
```
public String toJson(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(ByteBuffer byteBuffer,
                   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,
                      String additionalFieldPrefix)

toUDPBuffers
```
public ByteBuffer[] toUDPBuffers()
```

toUDPBuffers

public ByteBuffer[] toUDPBuffers(ByteBuffer buffer,
                                 ByteBuffer tempBuffer)

toTCPBuffer
```
public ByteBuffer toTCPBuffer()
```

toTCPBuffer

public ByteBuffer toTCPBuffer(ByteBuffer buffer)

sliceDatagrams

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

getVersion
```
public String getVersion()
```

setVersion

public void setVersion(String version)

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getShortMessage
```
public String getShortMessage()
```

setShortMessage

public void setShortMessage(String shortMessage)

getFullMessage
```
public String getFullMessage()
```

setFullMessage

public void setFullMessage(String fullMessage)

getTimestampAsBigDecimal

public BigDecimal getTimestampAsBigDecimal()

getTimestamp
```
public String getTimestamp()
```

getJavaTimestamp
```
public Long getJavaTimestamp()
```

setJavaTimestamp

public void setJavaTimestamp(long javaTimestamp)

getLevel
```
public String getLevel()
```

setLevel
```
public void setLevel(String level)
```

getFacility
```
public String getFacility()
```

setFacility

public void setFacility(String facility)

getAdditionalFieldTypes

public Map<String,String> getAdditionalFieldTypes()

setAdditionalFieldTypes

public void setAdditionalFieldTypes(Map<String,String> additionalFieldTypes)

setDynamicMdcFieldTypes

public void setDynamicMdcFieldTypes(Map<Pattern,String> dynamicMdcFieldTypes)

addFields
```
public GelfMessage addFields(Map<String,String> fields)
```
Add multiple fields (key/value pairs)

Parameters:

fields - map of fields

Returns:

the current GelfMessage.

addField

public GelfMessage addField(String key,
                            String value)

Add a particular field.

Parameters:: key - the key; value - the value
Returns:: the current GelfMessage.

getAdditonalFields

public Map<String,String> getAdditonalFields()

isValid
```
public boolean isValid()
```

isEmpty

public static boolean isEmpty(String str)

getMaximumMessageSize
```
public int getMaximumMessageSize()
```

setMaximumMessageSize

public void setMaximumMessageSize(int maximumMessageSize)

getField

public String getField(String fieldName)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class GelfMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_HOST

FIELD_SHORT_MESSAGE

FIELD_FULL_MESSAGE

FIELD_TIMESTAMP

FIELD_LEVEL

FIELD_FACILITY

FIELD_VERSION

ID_NAME

FIELD_TYPE_DISCOVER

FIELD_TYPE_STRING

FIELD_TYPE_LONG

FIELD_TYPE_LONG2

FIELD_TYPE_DOUBLE

FIELD_TYPE_DOUBLE2

FIELD_TYPE_DEFAULT

GELF_VERSION_1_0

GELF_VERSION_1_1

GELF_VERSION

DEFAULT_FACILITY

DEFAULT_MESSAGE_SIZE

DEFAUL_LEVEL

Constructor Detail

GelfMessage

GelfMessage

Method Detail

toJson

toJson

toJson

toJson

toUDPBuffers

toUDPBuffers

toTCPBuffer

toTCPBuffer

sliceDatagrams

getVersion

setVersion

getHost

setHost

getShortMessage

setShortMessage

getFullMessage

setFullMessage

getTimestampAsBigDecimal

getTimestamp

getJavaTimestamp

setJavaTimestamp

getLevel

setLevel

getFacility

setFacility

getAdditionalFieldTypes

setAdditionalFieldTypes

setDynamicMdcFieldTypes

addFields

addField

getAdditonalFields

isValid

isEmpty

getMaximumMessageSize

setMaximumMessageSize

getField

equals

hashCode