net.logstash.logback.encoder

Class LogstashEncoder

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.encoder.EncoderBase<Event>

net.logstash.logback.encoder.CompositeJsonEncoder<ch.qos.logback.classic.spi.ILoggingEvent>

net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder

net.logstash.logback.encoder.LogstashEncoder

All Implemented Interfaces:

ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

Direct Known Subclasses:

LogstashTcpEncoder

public class LogstashEncoder
extends LoggingEventCompositeJsonEncoder

Field Summary

Fields inherited from class ch.qos.logback.core.encoder.EncoderBase

outputStream, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
LogstashEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExcludeMdcKeyName(String excludedMdcKeyName)
void	addIncludeMdcKeyName(String includedMdcKeyName)
void	addProvider(JsonProvider<ch.qos.logback.classic.spi.ILoggingEvent> provider)
protected CompositeJsonFormatter<ch.qos.logback.classic.spi.ILoggingEvent>	createFormatter()
String	getCustomFields()
List<String>	getExcludeMdcKeyNames()
LogstashFieldNames	getFieldNames()
protected LogstashFormatter	getFormatter()
List<String>	getIncludeMdcKeyNames()
int	getShortenedLoggerNameLength()
ch.qos.logback.classic.pattern.ThrowableHandlingConverter	getThrowableConverter()
String	getTimeZone()
boolean	isEnableContextMap() Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.
boolean	isIncludeCallerInfo()
boolean	isIncludeContext()
boolean	isIncludeMdc()
void	setCustomFields(String customFields)
void	setEnableContextMap(boolean enableContextMap) Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.
void	setExcludeMdcKeyNames(List<String> excludeMdcKeyNames)
void	setFieldNames(LogstashFieldNames fieldNames)
void	setIncludeCallerInfo(boolean includeCallerInfo)
void	setIncludeContext(boolean includeContext)
void	setIncludeMdc(boolean includeMdc)
void	setIncludeMdcKeyNames(List<String> includeMdcKeyNames)
void	setShortenedLoggerNameLength(int length)
void	setThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)
void	setTimeZone(String timeZoneId)

Methods inherited from class net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder

setProviders

Methods inherited from class net.logstash.logback.encoder.CompositeJsonEncoder

close, doEncode, getEncoding, getJsonFactoryDecorator, getJsonGeneratorDecorator, getLineSeparator, getPrefix, getProviders, getSuffix, init, isImmediateFlush, setEncoding, setImmediateFlush, setJsonFactoryDecorator, setJsonGeneratorDecorator, setLineSeparator, setPrefix, setSuffix, start, stop

Methods inherited from class ch.qos.logback.core.encoder.EncoderBase

isStarted

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Constructor Detail

LogstashEncoder

public LogstashEncoder()

Method Detail

createFormatter

protected CompositeJsonFormatter<ch.qos.logback.classic.spi.ILoggingEvent> createFormatter()

Overrides:

createFormatter in class LoggingEventCompositeJsonEncoder

getFormatter

protected LogstashFormatter getFormatter()

Overrides:

getFormatter in class CompositeJsonEncoder<ch.qos.logback.classic.spi.ILoggingEvent>

addProvider

public void addProvider(JsonProvider<ch.qos.logback.classic.spi.ILoggingEvent> provider)

isIncludeCallerInfo

public boolean isIncludeCallerInfo()

setIncludeCallerInfo

public void setIncludeCallerInfo(boolean includeCallerInfo)

setCustomFields

public void setCustomFields(String customFields)

getCustomFields

public String getCustomFields()

getFieldNames

public LogstashFieldNames getFieldNames()

setFieldNames

public void setFieldNames(LogstashFieldNames fieldNames)

getShortenedLoggerNameLength

public int getShortenedLoggerNameLength()

setShortenedLoggerNameLength

public void setShortenedLoggerNameLength(int length)

isIncludeMdc

public boolean isIncludeMdc()

setIncludeMdc

public void setIncludeMdc(boolean includeMdc)

getIncludeMdcKeyNames

public List<String> getIncludeMdcKeyNames()

addIncludeMdcKeyName

public void addIncludeMdcKeyName(String includedMdcKeyName)

setIncludeMdcKeyNames

public void setIncludeMdcKeyNames(List<String> includeMdcKeyNames)

getExcludeMdcKeyNames

public List<String> getExcludeMdcKeyNames()

addExcludeMdcKeyName

public void addExcludeMdcKeyName(String excludedMdcKeyName)

setExcludeMdcKeyNames

public void setExcludeMdcKeyNames(List<String> excludeMdcKeyNames)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

setEnableContextMap

@Deprecated
public void setEnableContextMap(boolean enableContextMap)

Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.

If set to true the encoder will search logging event array and if the last item is a Map, entries will be included in the message.

Example:

 log.info("Service started in {} seconds", duration / 1000, Collections.singletonMap("duration", duration))
 

Will produce:

 {
     "@timestamp": "2014-06-04T15:26:14.464+02:00",
     "message": "Service started in 8 seconds",
     "level": "INFO",
     "duration": 8496
     ...
 

Parameters:

enableContextMap - true to enable context map

isEnableContextMap

@Deprecated
public boolean isEnableContextMap()

Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.

getThrowableConverter

public ch.qos.logback.classic.pattern.ThrowableHandlingConverter getThrowableConverter()

setThrowableConverter

public void setThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)