net.logstash.logback.marker

Class ObjectAppendingMarker

java.lang.Object

net.logstash.logback.marker.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.SingleFieldAppendingMarker

net.logstash.logback.marker.ObjectAppendingMarker

All Implemented Interfaces:

Serializable, Iterable<org.slf4j.Marker>, StructuredArgument, org.slf4j.Marker

public class ObjectAppendingMarker
extends SingleFieldAppendingMarker

A Marker OR StructuredArgument that writes an object under a given fieldName in the log event output.

When writing to the JSON data (via ArgumentsJsonProvider or LogstashMarkersJsonProvider), the object will be converted into an appropriate JSON type (number, string, object, array) and written to the JSON event under a given fieldName.

When writing to a String (when used as a StructuredArgument to the event's formatted message), as specified in SingleFieldAppendingMarker, the SingleFieldAppendingMarker.messageFormatPattern is used to construct the string to include in the event's formatted message. StructuredArguments.toString(Object) will be used to convert the value to a string, prior to being substituted into the messageFormatPattern.

An ObjectMapper is used to convert/write the value when writing to JSON, so as long as the ObjectMapper can convert the object, you're good. For example, to append a string field, use a String object as the object. To append a numeric field, use a Number object as the object. To append an array field, use an array as the object. To append an object field, use some other Object as the object.

Example:

 logger.info("My Message {}", StructuredArguments.keyValue("key", "value"));
 

results in the following log event output:

 {
     "message" : "My Message key=value",
     "key"     : "value"
 }
 

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.SingleFieldAppendingMarker

MARKER_NAME_PREFIX

Fields inherited from interface org.slf4j.Marker

ANY_MARKER, ANY_NON_NULL_MARKER

Constructor Summary

Constructors

Constructor and Description
ObjectAppendingMarker(String fieldName, Object object)
ObjectAppendingMarker(String fieldName, Object object, String messageFormatPattern)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	getFieldValue() Return the value that should be included in the output of LogstashMarker.toString().
int	hashCode()
protected void	writeFieldValue(JsonGenerator generator) Writes the field value to the generator.

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

getFieldName, toStringSelf, writeFieldName, writeTo

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

and, toString, 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

Methods inherited from interface net.logstash.logback.argument.StructuredArgument

toString

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

MARKER_NAME

public static final String MARKER_NAME

See Also:

Constant Field Values

Constructor Detail

ObjectAppendingMarker

public ObjectAppendingMarker(String fieldName,
                             Object object)

ObjectAppendingMarker

public ObjectAppendingMarker(String fieldName,
                             Object object,
                             String messageFormatPattern)

Method Detail

writeFieldValue

protected void writeFieldValue(JsonGenerator generator)
                        throws IOException

Description copied from class: SingleFieldAppendingMarker

Writes the field value to the generator.

Specified by:

writeFieldValue in class SingleFieldAppendingMarker

Throws:

IOException

getFieldValue

public Object getFieldValue()

Description copied from class: SingleFieldAppendingMarker

Return the value that should be included in the output of LogstashMarker.toString().

Specified by:

getFieldValue in class SingleFieldAppendingMarker

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.slf4j.Marker

Overrides:

equals in class SingleFieldAppendingMarker

hashCode

public int hashCode()

Specified by:

hashCode in interface org.slf4j.Marker

Overrides:

hashCode in class SingleFieldAppendingMarker