net.logstash.logback.marker

Class ObjectFieldsAppendingMarker

java.lang.Object

org.slf4j.helpers.BasicMarker

org.slf4j.helpers.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.ObjectFieldsAppendingMarker

All Implemented Interfaces:

java.io.Serializable, org.slf4j.Marker

public class ObjectFieldsAppendingMarker
extends LogstashMarker

A marker that first converts an object to a JsonNode, and then appends the fields of the JsonNode into the logstash event.

Unless the object is already a JsonNode), this may not be very efficient, so prefer using one of the other {@link LogstashMarker}s. It is included here for convenience where performance is not a concern.

The object will be converted to a {@link JsonNode} via {@link ObjectMapper#convertValue(Object, Class)};

For example, if the converted JsonNode is

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

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

For example:

 {@code
 {

Version:

: 1, 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 java.lang.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(java.lang.Object object)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
void	writeTo(com.fasterxml.jackson.core.JsonGenerator generator, com.fasterxml.jackson.databind.ObjectMapper mapper) Writes the data associated with this marker to the given JsonGenerator.

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

with

Methods inherited from class org.slf4j.helpers.BasicMarker

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

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_NAME

public static final java.lang.String MARKER_NAME

See Also:

Constant Field Values

Constructor Detail

ObjectFieldsAppendingMarker

public ObjectFieldsAppendingMarker(java.lang.Object object)

Method Detail

writeTo

public void writeTo(com.fasterxml.jackson.core.JsonGenerator generator,
           com.fasterxml.jackson.databind.ObjectMapper mapper)
             throws java.io.IOException

Description copied from class: LogstashMarker

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

The ObjectMapper can be used to write objects if necessary. In particular ObjectMapper.writeValue(JsonGenerator, Object), ObjectMapper.writeTree(JsonGenerator, com.fasterxml.jackson.databind.JsonNode), and ObjectMapper.writeTree(JsonGenerator, com.fasterxml.jackson.core.TreeNode) can be useful.

Specified by:

writeTo in class LogstashMarker

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface org.slf4j.Marker

Overrides:

equals in class org.slf4j.helpers.BasicMarker

hashCode

public int hashCode()

Specified by:

hashCode in interface org.slf4j.Marker

Overrides:

hashCode in class org.slf4j.helpers.BasicMarker