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<ILoggingEvent>

net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder

net.logstash.logback.encoder.LogstashEncoder

All Implemented Interfaces:

Encoder<ILoggingEvent>, ContextAware, LifeCycle

Direct Known Subclasses:

LogstashTcpEncoder

public class LogstashEncoder
extends LoggingEventCompositeJsonEncoder

Field Summary

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

started

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

context

Constructor Summary

Constructors

Constructor and Description
LogstashEncoder()

Method Summary

Modifier and Type	Method and Description
void	addExcludeMdcKeyName(String excludedMdcKeyName)
void	addIncludeMdcKeyName(String includedMdcKeyName)
void	addMdcKeyFieldName(String mdcKeyFieldName)
void	addProvider(JsonProvider<ILoggingEvent> provider)
protected CompositeJsonFormatter<ILoggingEvent>	createFormatter()
String	getCustomFields()
List<String>	getExcludeMdcKeyNames()
LogstashFieldNames	getFieldNames()
protected LogstashFormatter	getFormatter()
List<String>	getIncludeMdcKeyNames()
String	getMessageSplitRegex() Write the message as a JSON array by splitting the message text using the specified regex.
String	getNonStructuredArgumentsFieldPrefix()
int	getShortenedLoggerNameLength()
ThrowableHandlingConverter	getThrowableConverter()
String	getTimestampPattern()
String	getTimeZone()
String	getVersion()
boolean	isEnableContextMap() Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.
boolean	isIncludeCallerData()
boolean	isIncludeCallerInfo() Deprecated. use isIncludeCallerData() (to use the same name that logback uses)
boolean	isIncludeContext()
boolean	isIncludeMdc()
boolean	isIncludeNonStructuredArguments()
boolean	isIncludeStructuredArguments()
boolean	isIncludeTags()
boolean	isWriteVersionAsInteger()
boolean	isWriteVersionAsString() Deprecated. Use isWriteVersionAsInteger()
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	setIncludeCallerData(boolean includeCallerData)
void	setIncludeCallerInfo(boolean includeCallerInfo) Deprecated. use setIncludeCallerData(boolean) (to use the same name that logback uses)
void	setIncludeContext(boolean includeContext)
void	setIncludeMdc(boolean includeMdc)
void	setIncludeMdcKeyNames(List<String> includeMdcKeyNames)
void	setIncludeNonStructuredArguments(boolean includeNonStructuredArguments)
void	setIncludeStructuredArguments(boolean includeStructuredArguments)
void	setIncludeTags(boolean includeTags)
void	setMessageSplitRegex(String messageSplitRegex) Write the message as a JSON array by splitting the message text using the specified regex.
void	setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix)
void	setShortenedLoggerNameLength(int length)
void	setThrowableConverter(ThrowableHandlingConverter throwableConverter)
void	setTimestampPattern(String pattern)
void	setTimeZone(String timeZoneId)
void	setVersion(String version)
void	setWriteVersionAsInteger(boolean writeVersionAsInteger)
void	setWriteVersionAsString(boolean writeVersionAsString) Deprecated. Use setWriteVersionAsInteger(boolean)

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

setProviders

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

close, doEncode, doEncode, encode, footerBytes, getEncoding, getJsonFactoryDecorator, getJsonGeneratorDecorator, getLineSeparator, getMinBufferSize, getPrefix, getProviders, getSuffix, headerBytes, init, isImmediateFlush, setEncoding, setFindAndRegisterJacksonModules, setImmediateFlush, setJsonFactoryDecorator, setJsonGeneratorDecorator, setLineSeparator, setLogback11Support, setMinBufferSize, 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<ILoggingEvent> createFormatter()

Overrides:

createFormatter in class LoggingEventCompositeJsonEncoder

getFormatter

protected LogstashFormatter getFormatter()

Overrides:

getFormatter in class CompositeJsonEncoder<ILoggingEvent>

addProvider

public void addProvider(JsonProvider<ILoggingEvent> provider)

isIncludeCallerData

public boolean isIncludeCallerData()

setIncludeCallerData

public void setIncludeCallerData(boolean includeCallerData)

isIncludeCallerInfo

@Deprecated
public boolean isIncludeCallerInfo()

Deprecated. use isIncludeCallerData() (to use the same name that logback uses)

setIncludeCallerInfo

@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo)

Deprecated. use setIncludeCallerData(boolean) (to use the same name that logback uses)

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)

addMdcKeyFieldName

public void addMdcKeyFieldName(String mdcKeyFieldName)

isIncludeTags

public boolean isIncludeTags()

setIncludeTags

public void setIncludeTags(boolean includeTags)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

isIncludeStructuredArguments

public boolean isIncludeStructuredArguments()

setIncludeStructuredArguments

public void setIncludeStructuredArguments(boolean includeStructuredArguments)

isIncludeNonStructuredArguments

public boolean isIncludeNonStructuredArguments()

setIncludeNonStructuredArguments

public void setIncludeNonStructuredArguments(boolean includeNonStructuredArguments)

getNonStructuredArgumentsFieldPrefix

public String getNonStructuredArgumentsFieldPrefix()

setNonStructuredArgumentsFieldPrefix

public void setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix)

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 ThrowableHandlingConverter getThrowableConverter()

setThrowableConverter

public void setThrowableConverter(ThrowableHandlingConverter throwableConverter)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)

getTimestampPattern

public String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(String pattern)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

isWriteVersionAsString

@Deprecated
public boolean isWriteVersionAsString()

Deprecated. Use isWriteVersionAsInteger()

setWriteVersionAsString

@Deprecated
public void setWriteVersionAsString(boolean writeVersionAsString)

Deprecated. Use setWriteVersionAsInteger(boolean)

isWriteVersionAsInteger

public boolean isWriteVersionAsInteger()

setWriteVersionAsInteger

public void setWriteVersionAsInteger(boolean writeVersionAsInteger)

getMessageSplitRegex

public String getMessageSplitRegex()

Write the message as a JSON array by splitting the message text using the specified regex.

Returns:

The regex used to split the message text

setMessageSplitRegex

public void setMessageSplitRegex(String messageSplitRegex)

Write the message as a JSON array by splitting the message text using the specified regex.

The allowed values are:

• Null/Empty : Disable message splitting. This is also the default behavior.
• Any valid regex : Use the specified regex.
• SYSTEM : Use the system-default line separator.
• UNIX : Use \n.
• WINDOWS : Use \r\n.

For example, if this parameter is set to the regex #+, then the logging statement:

 log.info("First line##Second line###Third line")
 

will produce:

 {
     ...
     "message": [
         "First line",
         "Second line",
         "Third line"
     ],
     ...
 }
 

Parameters:

messageSplitRegex - The regex used to split the message text