net.logstash.logback.marker

Class ObjectFieldsAppendingMarker

java.lang.Object

net.logstash.logback.marker.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.ObjectFieldsAppendingMarker

All Implemented Interfaces:

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

public class ObjectFieldsAppendingMarker
extends LogstashMarker
implements StructuredArgument

A Marker OR StructuredArgument that that "unwraps" the given object into the logstash event.

When writing to the JSON data (via ArgumentsJsonProvider or LogstashMarkersJsonProvider), the fields of the object are written inline into the JSON event similar to how the com.fasterxml.jackson.annotation.JsonUnwrapped annotation works.

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

For example, if the message is "mymessage {}", and the object argument is:

 {
     name1 : "value1",
     name2 : 5,
     name3 : [1, 2, 3],
     name4 : {
         name5 : 6
     }
 }
 

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

For example:

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

Note that if the object cannot be unwrapped, then nothing will be written.

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
ObjectFieldsAppendingMarker(Object object)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
String	toStringSelf() Returns a string representation of this object, without including any references.
void	writeTo(JsonGenerator generator) Writes the data associated with this marker to the given JsonGenerator.

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

ObjectFieldsAppendingMarker

public ObjectFieldsAppendingMarker(Object object)

Method Detail

writeTo

public void writeTo(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

Parameters:

generator - the generator to which to write the output of this marker.

Throws:

IOException - if there was an error writing to the generator

toStringSelf

public String toStringSelf()

Description copied from class: LogstashMarker

Returns a string representation of this object, without including any references.

Subclasses should override LogstashMarker.toStringSelf() instead of LogstashMarker.toString(), since LogstashMarker.toString() will automatically include the LogstashMarker.toStringSelf() and references.

Overrides:

toStringSelf in class LogstashMarker

Returns:

a string representation of this object, without including any references.

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