net.logstash.logback.marker

Class MapEntriesAppendingMarker

java.lang.Object

net.logstash.logback.marker.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.MapEntriesAppendingMarker

All Implemented Interfaces:

Serializable, StructuredArgument, org.slf4j.Marker

public class MapEntriesAppendingMarker
extends LogstashMarker
implements StructuredArgument

A Marker OR StructuredArgument that appends entries from a Map into the logging event output.

When writing to the JSON data (via ArgumentsJsonProvider or LogstashMarkersJsonProvider):

• Keys are converted to a String via String.valueOf(Object), and used as field names.
• Values are converted using an ObjectMapper.

When writing to a String (when used as a StructuredArgument to the event's formatted message), String.valueOf(Object) is used to convert the map to a string.

For example, if the message is "mymessage {}", and map argument contains is

 name1= a String "value1",
 name2= an Integer 5,
 name3= an array containing [1, 2, 3],
 name4= a map containing  name5=6 
 
 

Then the message, name1, name2, name3, name4 fields will be added to the json for the logstash event.

For example:

 {
     "message" : "mymessage [name1=value1,name2=5,name3=[b...,name4=[name5=6]]",
     "name1"   : "value1",
     "name2"   : 5,
     "name3"   : [1, 2, 3],
     "name4"   : { "name5" : 6 }
 }
 

 
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MARKER_NAME

Fields inherited from class net.logstash.logback.marker.LogstashMarker

MARKER_NAME_PREFIX

Fields inherited from interface org.slf4j.Marker

ANY_MARKER, ANY_NON_NULL_MARKER

Constructor Summary

Constructors

Constructor and Description
MapEntriesAppendingMarker(Map<?,?> map)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
String	toString() Writes the data associated with this argument to a String to be included in a log event's formatted message (via parameter substitution).
void	writeTo(com.fasterxml.jackson.core.JsonGenerator generator) Writes the data associated with this marker to the given JsonGenerator.

Methods inherited from class net.logstash.logback.marker.LogstashMarker

and, with

Methods inherited from class net.logstash.logback.marker.LogstashBasicMarker

add, contains, contains, getName, hasChildren, hasReferences, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_NAME

public static final String MARKER_NAME

See Also:

Constant Field Values

Constructor Detail

MapEntriesAppendingMarker

public MapEntriesAppendingMarker(Map<?,?> map)

Method Detail

writeTo

public void writeTo(com.fasterxml.jackson.core.JsonGenerator generator)
             throws IOException

Description copied from class: LogstashMarker

Writes the data associated with this marker to the given JsonGenerator.

Specified by:

writeTo in interface StructuredArgument

Specified by:

writeTo in class LogstashMarker

Throws:

IOException

toString

public String toString()

Description copied from interface: StructuredArgument

Writes the data associated with this argument to a String to be included in a log event's formatted message (via parameter substitution).

Note that this will only be included in the log event's formatted message if the message format includes a parameter for this argument.

Specified by:

toString in interface StructuredArgument

Overrides:

toString in class LogstashBasicMarker

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.slf4j.Marker

Overrides:

equals in class LogstashBasicMarker

hashCode

public int hashCode()

Specified by:

hashCode in interface org.slf4j.Marker

Overrides:

hashCode in class LogstashBasicMarker