net.logstash.logback.marker

Class RawJsonAppendingMarker

java.lang.Object

net.logstash.logback.marker.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.SingleFieldAppendingMarker

net.logstash.logback.marker.RawJsonAppendingMarker

All Implemented Interfaces:

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

public class RawJsonAppendingMarker
extends SingleFieldAppendingMarker

A Marker OR StructuredArgument that writes a raw json value to the logstash json event under a given field name.

When writing to the JSON data (via ArgumentsJsonProvider or LogstashMarkersJsonProvider), the raw string is written verbatim without any modifications, but assuming it must constitute a single legal JSON value (number, string, boolean, null, Array or List)

When writing to a String (when used as a StructuredArgument to the event's formatted message), the raw string is written as the field value. Note that using RawJsonAppendingMarker as a StructuredArgument is not very common.

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
RawJsonAppendingMarker(String fieldName, String rawJson)
RawJsonAppendingMarker(String fieldName, String rawJson, 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, toString, 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

RawJsonAppendingMarker

public RawJsonAppendingMarker(String fieldName,
                              String rawJson)

RawJsonAppendingMarker

public RawJsonAppendingMarker(String fieldName,
                              String rawJson,
                              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