net.logstash.logback.marker

Class LogstashMarker

java.lang.Object

net.logstash.logback.marker.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

All Implemented Interfaces:

Serializable, org.slf4j.Marker

Direct Known Subclasses:

MapEntriesAppendingMarker, ObjectFieldsAppendingMarker, SingleFieldAppendingMarker

public abstract class LogstashMarker
extends LogstashBasicMarker

A Marker that is known and understood by the logstash logback encoder.

In particular these markers are used to write data into the logstash json event via writeTo(JsonGenerator).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MARKER_NAME_PREFIX

Fields inherited from interface org.slf4j.Marker

ANY_MARKER, ANY_NON_NULL_MARKER

Constructor Summary

Constructors

Constructor and Description
LogstashMarker(String name)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends LogstashMarker> T	and(org.slf4j.Marker reference) Adds the given marker as a reference, and returns this marker.
<T extends LogstashMarker> T	with(org.slf4j.Marker reference) Deprecated. Use and(Marker) instead
abstract 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.LogstashBasicMarker

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

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_NAME_PREFIX

public static final String MARKER_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

LogstashMarker

public LogstashMarker(String name)

Method Detail

and

public <T extends LogstashMarker> T and(org.slf4j.Marker reference)

Adds the given marker as a reference, and returns this marker.

This can be used to chain markers together fluently on a log line. For example:

 import static net.logstash.logback.marker.Markers.*
     
 logger.info(append("name1", "value1).and(append("name2", "value2")), "log message");
 
 

with

@Deprecated
public <T extends LogstashMarker> T with(org.slf4j.Marker reference)

Deprecated. Use and(Marker) instead

See Also:

and(Marker)

writeTo

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

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

Throws:

IOException