Package 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
,StreamingEncoder<ILoggingEvent>
-
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addExcludeMdcKeyName
(String excludedMdcKeyName) void
addIncludeMdcKeyName
(String includedMdcKeyName) void
addMdcKeyFieldName
(String mdcKeyFieldName) void
addProvider
(JsonProvider<ILoggingEvent> provider) protected AbstractCompositeJsonFormatter<ILoggingEvent>
protected LogstashFormatter
Write the message as a JSON array by splitting the message text using the specified regex.int
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
setCustomFields
(String customFields) void
setExcludeMdcKeyNames
(List<String> excludeMdcKeyNames) void
setFieldNames
(LogstashFieldNames fieldNames) void
setIncludeCallerData
(boolean includeCallerData) 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) Methods inherited from class net.logstash.logback.encoder.CompositeJsonEncoder
encode, encode, footerBytes, getEncoding, getJsonFactoryDecorator, getJsonGeneratorDecorator, getLineSeparator, getMinBufferSize, getPrefix, getProviders, getSuffix, headerBytes, setEncoding, setFindAndRegisterJacksonModules, setJsonFactoryDecorator, setJsonGeneratorDecorator, setLineSeparator, 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 Details
-
LogstashEncoder
public LogstashEncoder()
-
-
Method Details
-
createFormatter
- Overrides:
createFormatter
in classLoggingEventCompositeJsonEncoder
-
getFormatter
- Overrides:
getFormatter
in classCompositeJsonEncoder<ILoggingEvent>
-
addProvider
-
isIncludeCallerData
public boolean isIncludeCallerData() -
setIncludeCallerData
public void setIncludeCallerData(boolean includeCallerData) -
setCustomFields
-
getCustomFields
-
getFieldNames
-
setFieldNames
-
getShortenedLoggerNameLength
public int getShortenedLoggerNameLength() -
setShortenedLoggerNameLength
public void setShortenedLoggerNameLength(int length) -
isIncludeMdc
public boolean isIncludeMdc() -
setIncludeMdc
public void setIncludeMdc(boolean includeMdc) -
getIncludeMdcKeyNames
-
addIncludeMdcKeyName
-
setIncludeMdcKeyNames
-
getExcludeMdcKeyNames
-
addExcludeMdcKeyName
-
setExcludeMdcKeyNames
-
addMdcKeyFieldName
-
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
-
setNonStructuredArgumentsFieldPrefix
-
getThrowableConverter
-
setThrowableConverter
-
getTimeZone
-
setTimeZone
-
getTimestampPattern
-
setTimestampPattern
-
getVersion
-
setVersion
-
isWriteVersionAsInteger
public boolean isWriteVersionAsInteger() -
setWriteVersionAsInteger
public void setWriteVersionAsInteger(boolean writeVersionAsInteger) -
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
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
-
setProviders
- Overrides:
setProviders
in classLoggingEventCompositeJsonEncoder
-