net.logstash.logback

Class LogstashFormatter

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

net.logstash.logback.composite.CompositeJsonFormatter<ILoggingEvent>

net.logstash.logback.composite.loggingevent.LoggingEventCompositeJsonFormatter

net.logstash.logback.LogstashFormatter

All Implemented Interfaces:

ContextAware, LifeCycle

public class LogstashFormatter
extends LoggingEventCompositeJsonFormatter

A LoggingEventCompositeJsonFormatter that contains a common pre-defined set of JsonProviders. The included providers are configured via properties on this formatter, rather than configuring the providers directly. This leads to a somewhat simpler configuration definitions. You cannot remove any of the pre-defined providers, but you can add additional providers via addProvider(JsonProvider). If you would like full control over the providers, you should instead use LoggingEventCompositeJsonFormatter directly.

Field Summary

Fields

Modifier and Type	Field and Description
protected LogstashFieldNames	fieldNames The field names to use when writing the standard event fields

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

context

Constructor Summary

Constructors

Constructor and Description
LogstashFormatter(ContextAware declaredOrigin)
LogstashFormatter(ContextAware declaredOrigin, boolean includeCallerInfo)
LogstashFormatter(ContextAware declaredOrigin, boolean includeCallerInfo, JsonNode customFields)

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 void	configureProviderFieldNames()
JsonNode	getCustomFields()
String	getCustomFieldsAsString()
List<String>	getExcludeMdcKeyNames()
LogstashFieldNames	getFieldNames()
List<String>	getIncludeMdcKeyNames()
String	getMessageSplitRegex() Write the message as a JSON array by splitting the message text using the specified regex.
String	getNonStructuredArgumentsFieldPrefix()
LoggingEventJsonProviders	getProviders()
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(JsonNode customFields)
void	setCustomFieldsFromString(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	setProviders(JsonProviders<ILoggingEvent> jsonProviders)
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)
void	start()

Methods inherited from class net.logstash.logback.composite.CompositeJsonFormatter

getEncoding, getJsonFactory, getJsonFactoryDecorator, getJsonGeneratorDecorator, isFindAndRegisterJacksonModules, isStarted, prepareForDeferredProcessing, setEncoding, setFindAndRegisterJacksonModules, setJsonFactoryDecorator, setJsonGeneratorDecorator, stop, writeEventAsBytes, writeEventAsString, writeEventToGenerator, writeEventToOutputStream

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

Field Detail

fieldNames

protected LogstashFieldNames fieldNames

The field names to use when writing the standard event fields

Constructor Detail

LogstashFormatter

public LogstashFormatter(ContextAware declaredOrigin)

LogstashFormatter

public LogstashFormatter(ContextAware declaredOrigin,
                         boolean includeCallerInfo)

LogstashFormatter

public LogstashFormatter(ContextAware declaredOrigin,
                         boolean includeCallerInfo,
                         JsonNode customFields)

Method Detail

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class CompositeJsonFormatter<ILoggingEvent>

configureProviderFieldNames

protected void configureProviderFieldNames()

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)

Returns:

true if the caller info should be included

setIncludeCallerInfo

@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo)

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

Parameters:

includeCallerInfo - true if the caller info should be included

getCustomFieldsAsString

public String getCustomFieldsAsString()

setCustomFieldsFromString

public void setCustomFieldsFromString(String customFields)

setCustomFields

public void setCustomFields(JsonNode customFields)

getCustomFields

public JsonNode getCustomFields()

getShortenedLoggerNameLength

public int getShortenedLoggerNameLength()

setShortenedLoggerNameLength

public void setShortenedLoggerNameLength(int length)

isIncludeMdc

public boolean isIncludeMdc()

setIncludeMdc

public void setIncludeMdc(boolean includeMdc)

isIncludeTags

public boolean isIncludeTags()

setIncludeTags

public void setIncludeTags(boolean includeTags)

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)

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)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

getThrowableConverter

public ThrowableHandlingConverter getThrowableConverter()

setThrowableConverter

public void setThrowableConverter(ThrowableHandlingConverter throwableConverter)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

isWriteVersionAsString

@Deprecated
public boolean isWriteVersionAsString()

Deprecated. Use isWriteVersionAsInteger()

Returns:

true if the version should be written as a string

setWriteVersionAsString

@Deprecated
public void setWriteVersionAsString(boolean writeVersionAsString)

Deprecated. Use setWriteVersionAsInteger(boolean)

Parameters:

writeVersionAsString - true if the version should be written as a string

isWriteVersionAsInteger

public boolean isWriteVersionAsInteger()

setWriteVersionAsInteger

public void setWriteVersionAsInteger(boolean writeVersionAsInteger)

isEnableContextMap

@Deprecated
public boolean isEnableContextMap()

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

Returns:

true if the last Map argument should be appended

setEnableContextMap

@Deprecated
public void setEnableContextMap(boolean enableContextMap)

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

Parameters:

enableContextMap - true if the last Map argument should be appended

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

addProvider

public void addProvider(JsonProvider<ILoggingEvent> provider)

getProviders

public LoggingEventJsonProviders getProviders()

Overrides:

getProviders in class CompositeJsonFormatter<ILoggingEvent>

getFieldNames

public LogstashFieldNames getFieldNames()

setFieldNames

public void setFieldNames(LogstashFieldNames fieldNames)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)

getTimestampPattern

public String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(String pattern)

setProviders

public void setProviders(JsonProviders<ILoggingEvent> jsonProviders)

Overrides:

setProviders in class LoggingEventCompositeJsonFormatter