net.logstash.logback.marker

Class LogstashMarker

java.lang.Object

org.slf4j.helpers.BasicMarker

org.slf4j.helpers.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

All Implemented Interfaces:

java.io.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, ObjectMapper).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MARKER_NAME_PREFIX

Fields inherited from interface org.slf4j.Marker

ANY_MARKER, ANY_NON_NULL_MARKER

Constructor Summary

Constructors

Constructor and Description
LogstashMarker(java.lang.String name)

Method Summary

Methods

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

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 java.lang.String MARKER_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

LogstashMarker

public LogstashMarker(java.lang.String name)

Method Detail

with

public <T extends LogstashMarker> T with(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).with(append("name2", "value2")), "log message");
 }
 

writeTo

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

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.

Throws:

java.io.IOException