Message (Graylog 4.1.1 API)

java.lang.Object
- org.graylog2.plugin.Message

All Implemented Interfaces:: Iterable<Message>, Indexable, Messages

@NotThreadSafe
public class Message
extends Object
implements Messages, Indexable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Message.MessageIdFunction
Deprecated.

static class Message.Recording

Nested Classes
Modifier and Type	Class and Description
`static class`	`Message.MessageIdFunction` Deprecated.
`static class`	`Message.Recording`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FIELD_FULL_MESSAGE`
`static String`	`FIELD_GL2_ACCOUNTED_MESSAGE_SIZE` Will be set to the accounted message size in bytes.
`static String`	`FIELD_GL2_MESSAGE_ID` This is the message ID.
`static String`	`FIELD_GL2_ORIGINAL_TIMESTAMP` Can be set when a message timestamp gets modified to preserve the original timestamp.
`static String`	`FIELD_GL2_PROCESSING_ERROR` Can be set to indicate a message processing error.
`static String`	`FIELD_GL2_PROCESSING_TIMESTAMP` Will be set to the message processing time after all message processors have been run.
`static String`	`FIELD_GL2_RECEIVE_TIMESTAMP` Will be set to the message receive time at the input.
`static String`	`FIELD_GL2_REMOTE_HOSTNAME` Will be set to the hostname of the source node that sent a message.
`static String`	`FIELD_GL2_REMOTE_IP` Will be set to the IP address of the source node that sent a message.
`static String`	`FIELD_GL2_REMOTE_PORT` Will be set to the socket port of the source node that sent a message.
`static String`	`FIELD_GL2_SOURCE_COLLECTOR` Can be set to the collector ID that sent a message.
`static String`	`FIELD_GL2_SOURCE_COLLECTOR_INPUT` Deprecated. This was used in the legacy collector/sidecar system and contained the database ID of the collector input.
`static String`	`FIELD_GL2_SOURCE_INPUT` Will be set to the ID of the input that received the message.
`static String`	`FIELD_GL2_SOURCE_NODE` Will be set to the ID of the node that received the message.
`static String`	`FIELD_GL2_SOURCE_RADIO` Deprecated. This was used with the now removed radio system and contained the ID of a radio node. TODO: Due to be removed in Graylog 3.x
`static String`	`FIELD_GL2_SOURCE_RADIO_INPUT` Deprecated. This was used with the now removed radio system and contained the input ID of a radio node. TODO: Due to be removed in Graylog 3.x
`static String`	`FIELD_ID` The "_id" is used as document ID to address the document in Elasticsearch.
`static String`	`FIELD_LEVEL`
`static String`	`FIELD_MESSAGE`
`static String`	`FIELD_SOURCE`
`static String`	`FIELD_STREAMS`
`static String`	`FIELD_TIMESTAMP`
`static com.google.common.collect.ImmutableSet<String>`	`FILTERED_FIELDS`
`static com.google.common.base.Function<Message,String>`	`ID_FUNCTION` Deprecated.
`static String`	`INTERNAL_FIELD_PREFIX` Graylog is writing internal metadata to messages using this field prefix.
`static com.google.common.collect.ImmutableSet<String>`	`RESERVED_FIELDS`
`static com.google.common.collect.ImmutableSet<String>`	`RESERVED_SETTABLE_FIELDS`

Constructor Summary

Constructors
Constructor and Description

Message(Map<String,Object> fields)

Message(String message, String source, org.joda.time.DateTime timestamp)

Constructors
Constructor and Description
`Message(Map<String,Object> fields)`
`Message(String message, String source, org.joda.time.DateTime timestamp)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDoubleFields(Map<String,Double> fields)` Deprecated.
`void`	`addField(String key, Object value)`
`void`	`addFields(Map<String,Object> fields)`
`void`	`addLongFields(Map<String,Long> fields)` Deprecated.
`void`	`addStream(Stream stream)` Assign the given stream to this message.
`void`	`addStreams(Iterable<Stream> newStreams)` Assign all of the streams to this message.
`void`	`addStringFields(Map<String,String> fields)` Deprecated.
`Object`	`getField(String key)`
`<T> T`	`getFieldAs(Class<T> T, String key)`
`int`	`getFieldCount()`
`Set<String>`	`getFieldNames()`
`Map<String,Object>`	`getFields()`
`Iterable<Map.Entry<String,Object>>`	`getFieldsEntries()`
`boolean`	`getFilterOut()`
`String`	`getId()`
`Set<IndexSet>`	`getIndexSets()` Return the index sets for this message based on the assigned streams.
`InetAddress`	`getInetAddress()`
`boolean`	`getIsSourceInetAddress()` Deprecated.
`long`	`getJournalOffset()` Deprecated. Use `getMessageQueueId()` instead.
`String`	`getMessage()`
`Object`	`getMessageQueueId()`
`org.joda.time.DateTime`	`getProcessingTime()`
`org.joda.time.DateTime`	`getReceiveTime()`
`long`	`getSize()`
`String`	`getSource()`
`String`	`getSourceInputId()`
`Collection<String>`	`getStreamIds()`
`Set<Stream>`	`getStreams()` Get the streams this message is currently routed to.
`org.joda.time.DateTime`	`getTimestamp()`
`String`	`getValidationErrors()` Deprecated.
`boolean`	`hasField(String field)`
`boolean`	`hasRecordings()`
`boolean`	`isComplete()`
`Iterator<Message>`	`iterator()`
`void`	`recordCounter(ServerStatus serverStatus, String name, int counter)`
`String`	`recordingsAsString()`
`void`	`recordTiming(ServerStatus serverStatus, String name, long elapsedNanos)`
`void`	`removeField(String key)`
`boolean`	`removeStream(Stream stream)` Remove the stream assignment from this message.
`void`	`setFilterOut(boolean filterOut)`
`void`	`setJournalOffset(long journalOffset)`
`void`	`setMessageQueueId(Object messageQueueId)`
`void`	`setProcessingTime(org.joda.time.DateTime processingTime)`
`void`	`setReceiveTime(org.joda.time.DateTime receiveTime)`
`void`	`setSource(String source)`
`void`	`setSourceInputId(String sourceInputId)`
`void`	`setStreams(List<Stream> streams)` Deprecated.
`String`	`toDumpString()`
`Map<String,Object>`	`toElasticSearchObject(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.codahale.metrics.Meter invalidTimestampMeter)`
`String`	`toString()`
`static boolean`	`validKey(String key)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - FIELD_ID
```
public static final String FIELD_ID
```
    The "_id" is used as document ID to address the document in Elasticsearch. TODO: We might want to use the "gl2_message_id" for this in the future to reduce storage and avoid having basically two different message IDs. To do that we have to check if switching to a different ID format breaks anything with regard to expectations in other code and existing data in Elasticsearch.
    
    See Also:
    
    Constant Field Values
  - FIELD_MESSAGE
```
public static final String FIELD_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FIELD_FULL_MESSAGE
```
public static final String FIELD_FULL_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FIELD_SOURCE
```
public static final String FIELD_SOURCE
```
    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_STREAMS
```
public static final String FIELD_STREAMS
```
    See Also:
    
    Constant Field Values
  - INTERNAL_FIELD_PREFIX
```
public static final String INTERNAL_FIELD_PREFIX
```
    Graylog is writing internal metadata to messages using this field prefix. Users must not use this prefix for custom message fields.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_ACCOUNTED_MESSAGE_SIZE
```
public static final String FIELD_GL2_ACCOUNTED_MESSAGE_SIZE
```
    Will be set to the accounted message size in bytes.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_MESSAGE_ID
```
public static final String FIELD_GL2_MESSAGE_ID
```
    This is the message ID. It will be set to a ULID during processing.
    Attention: This is currently NOT the "_id" field which is used as ID for the document in Elasticsearch!
    
    Implementation notes
    We are not using the UUID in "_id" for this field because of the following reasons:
    - Using ULIDs results in shorter IDs (26 characters for ULID vs 36 for UUID) and thus reduced storage usage
    - They are guaranteed to be lexicographically sortable (UUIDs are only lexicographically sortable when time-based ones are used)
    See: https://github.com/Graylog2/graylog2-server/issues/5994
    See Also:
    
    Constant Field Values
  - FIELD_GL2_ORIGINAL_TIMESTAMP
```
public static final String FIELD_GL2_ORIGINAL_TIMESTAMP
```
    Can be set when a message timestamp gets modified to preserve the original timestamp. (e.g. "clone_message" pipeline function)
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_PROCESSING_ERROR
```
public static final String FIELD_GL2_PROCESSING_ERROR
```
    Can be set to indicate a message processing error. (e.g. set by the pipeline interpreter when an error occurs)
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_PROCESSING_TIMESTAMP
```
public static final String FIELD_GL2_PROCESSING_TIMESTAMP
```
    Will be set to the message processing time after all message processors have been run. TODO: To be done in Graylog 3.2
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_RECEIVE_TIMESTAMP
```
public static final String FIELD_GL2_RECEIVE_TIMESTAMP
```
    Will be set to the message receive time at the input. TODO: To be done in Graylog 3.2
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_REMOTE_HOSTNAME
```
public static final String FIELD_GL2_REMOTE_HOSTNAME
```
    Will be set to the hostname of the source node that sent a message. (if reverse lookup is enabled)
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_REMOTE_IP
```
public static final String FIELD_GL2_REMOTE_IP
```
    Will be set to the IP address of the source node that sent a message.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_REMOTE_PORT
```
public static final String FIELD_GL2_REMOTE_PORT
```
    Will be set to the socket port of the source node that sent a message.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_SOURCE_COLLECTOR
```
public static final String FIELD_GL2_SOURCE_COLLECTOR
```
    Can be set to the collector ID that sent a message. (e.g. used in the beats codec)
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_SOURCE_COLLECTOR_INPUT
```
@Deprecated
public static final String FIELD_GL2_SOURCE_COLLECTOR_INPUT
```
    Deprecated. This was used in the legacy collector/sidecar system and contained the database ID of the collector input.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_SOURCE_INPUT
```
public static final String FIELD_GL2_SOURCE_INPUT
```
    Will be set to the ID of the input that received the message.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_SOURCE_NODE
```
public static final String FIELD_GL2_SOURCE_NODE
```
    Will be set to the ID of the node that received the message.
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_SOURCE_RADIO
```
@Deprecated
public static final String FIELD_GL2_SOURCE_RADIO
```
    Deprecated. This was used with the now removed radio system and contained the ID of a radio node. TODO: Due to be removed in Graylog 3.x
    
    See Also:
    
    Constant Field Values
  - FIELD_GL2_SOURCE_RADIO_INPUT
```
@Deprecated
public static final String FIELD_GL2_SOURCE_RADIO_INPUT
```
    Deprecated. This was used with the now removed radio system and contained the input ID of a radio node. TODO: Due to be removed in Graylog 3.x
    
    See Also:
    
    Constant Field Values
  - RESERVED_SETTABLE_FIELDS
```
public static final com.google.common.collect.ImmutableSet<String> RESERVED_SETTABLE_FIELDS
```
  - RESERVED_FIELDS
```
public static final com.google.common.collect.ImmutableSet<String> RESERVED_FIELDS
```
  - FILTERED_FIELDS
```
public static final com.google.common.collect.ImmutableSet<String> FILTERED_FIELDS
```
  - ID_FUNCTION
```
@Deprecated
public static final com.google.common.base.Function<Message,String> ID_FUNCTION
```
    Deprecated.
- Constructor Detail
  - Message
```
public Message(String message,
               String source,
               org.joda.time.DateTime timestamp)
```
  - Message
```
public Message(Map<String,Object> fields)
```
- Method Detail
  - isComplete
```
public boolean isComplete()
```
  - getValidationErrors
```
@Deprecated
public String getValidationErrors()
```
    Deprecated.
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface Indexable
  - getTimestamp
```
public org.joda.time.DateTime getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Indexable
  - toElasticSearchObject
```
public Map<String,Object> toElasticSearchObject(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                                @Nonnull
                                                com.codahale.metrics.Meter invalidTimestampMeter)
```
    Specified by:
    
    toElasticSearchObject in interface Indexable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toDumpString
```
public String toDumpString()
```
  - getMessage
```
public String getMessage()
```
  - getSource
```
public String getSource()
```
  - setSource
```
public void setSource(String source)
```
  - addField
```
public void addField(String key,
                     Object value)
```
  - getSize
```
public long getSize()
```
    Specified by:
    
    getSize in interface Indexable
  - validKey
```
public static boolean validKey(String key)
```
  - addFields
```
public void addFields(Map<String,Object> fields)
```
  - addStringFields
```
@Deprecated
public void addStringFields(Map<String,String> fields)
```
    Deprecated.
  - addLongFields
```
@Deprecated
public void addLongFields(Map<String,Long> fields)
```
    Deprecated.
  - addDoubleFields
```
@Deprecated
public void addDoubleFields(Map<String,Double> fields)
```
    Deprecated.
  - removeField
```
public void removeField(String key)
```
  - getFieldAs
```
public <T> T getFieldAs(Class<T> T,
                        String key)
                 throws ClassCastException
```
    Throws:
    
    ClassCastException
  - getField
```
public Object getField(String key)
```
  - getFields
```
public Map<String,Object> getFields()
```
  - getFieldsEntries
```
public Iterable<Map.Entry<String,Object>> getFieldsEntries()
```
  - getFieldCount
```
public int getFieldCount()
```
  - hasField
```
public boolean hasField(String field)
```
  - getFieldNames
```
public Set<String> getFieldNames()
```
  - setStreams
```
@Deprecated
public void setStreams(List<Stream> streams)
```
    Deprecated.
  - getStreams
```
public Set<Stream> getStreams()
```
    Get the streams this message is currently routed to.
    
    Returns:
    
    an immutable copy of the current set of assigned streams, empty if no streams have been assigned
  - addStream
```
public void addStream(Stream stream)
```
    Assign the given stream to this message.
    
    Parameters:
    
    stream - the stream to route this message into
  - addStreams
```
public void addStreams(Iterable<Stream> newStreams)
```
    Assign all of the streams to this message.
    
    Parameters:
    
    newStreams - an iterable of Stream objects
  - removeStream
```
public boolean removeStream(Stream stream)
```
    Remove the stream assignment from this message.
    
    Parameters:
    
    stream - the stream assignment to remove this message from
    
    Returns:
    
    true if this message was assigned to the stream
  - getIndexSets
```
public Set<IndexSet> getIndexSets()
```
    Return the index sets for this message based on the assigned streams.
    
    Returns:
    
    index sets
  - getStreamIds
```
public Collection<String> getStreamIds()
```
  - setFilterOut
```
public void setFilterOut(boolean filterOut)
```
  - getFilterOut
```
public boolean getFilterOut()
```
  - setSourceInputId
```
public void setSourceInputId(String sourceInputId)
```
  - getSourceInputId
```
public String getSourceInputId()
```
  - getIsSourceInetAddress
```
@Deprecated
public boolean getIsSourceInetAddress()
```
    Deprecated.
  - getInetAddress
```
public InetAddress getInetAddress()
```
  - setJournalOffset
```
public void setJournalOffset(long journalOffset)
```
  - getJournalOffset
```
@Deprecated
public long getJournalOffset()
```
    Deprecated. Use getMessageQueueId() instead.
  - setMessageQueueId
```
public void setMessageQueueId(Object messageQueueId)
```
  - getMessageQueueId
```
@Nullable
public Object getMessageQueueId()
```
  - getReceiveTime
```
@Nullable
public org.joda.time.DateTime getReceiveTime()
```
    Specified by:
    
    getReceiveTime in interface Indexable
  - setReceiveTime
```
public void setReceiveTime(org.joda.time.DateTime receiveTime)
```
  - getProcessingTime
```
@Nullable
public org.joda.time.DateTime getProcessingTime()
```
  - setProcessingTime
```
public void setProcessingTime(org.joda.time.DateTime processingTime)
```
  - recordTiming
```
public void recordTiming(ServerStatus serverStatus,
                         String name,
                         long elapsedNanos)
```
  - recordCounter
```
public void recordCounter(ServerStatus serverStatus,
                          String name,
                          int counter)
```
  - recordingsAsString
```
public String recordingsAsString()
```
  - hasRecordings
```
public boolean hasRecordings()
```
  - iterator
```
@Nonnull
public Iterator<Message> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Message>

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

FIELD_ID

FIELD_MESSAGE

FIELD_FULL_MESSAGE

FIELD_SOURCE

FIELD_TIMESTAMP

FIELD_LEVEL

FIELD_STREAMS

INTERNAL_FIELD_PREFIX

FIELD_GL2_ACCOUNTED_MESSAGE_SIZE

FIELD_GL2_MESSAGE_ID

Implementation notes

FIELD_GL2_ORIGINAL_TIMESTAMP

FIELD_GL2_PROCESSING_ERROR

FIELD_GL2_PROCESSING_TIMESTAMP

FIELD_GL2_RECEIVE_TIMESTAMP

FIELD_GL2_REMOTE_HOSTNAME

FIELD_GL2_REMOTE_IP

FIELD_GL2_REMOTE_PORT

FIELD_GL2_SOURCE_COLLECTOR

FIELD_GL2_SOURCE_COLLECTOR_INPUT

FIELD_GL2_SOURCE_INPUT

FIELD_GL2_SOURCE_NODE

FIELD_GL2_SOURCE_RADIO

FIELD_GL2_SOURCE_RADIO_INPUT

RESERVED_SETTABLE_FIELDS

RESERVED_FIELDS

FILTERED_FIELDS

ID_FUNCTION

Constructor Detail

Message

Message

Method Detail

isComplete

getValidationErrors

getId

getTimestamp

toElasticSearchObject

toString

toDumpString

getMessage

getSource

setSource

addField

getSize

validKey

addFields

addStringFields

addLongFields

addDoubleFields

removeField

getFieldAs

getField

getFields

getFieldsEntries

getFieldCount

hasField

getFieldNames

setStreams

getStreams

addStream

addStreams

removeStream

getIndexSets

getStreamIds

setFilterOut

getFilterOut

setSourceInputId

getSourceInputId

getIsSourceInetAddress

getInetAddress

setJournalOffset

getJournalOffset