net.logstash.logback

Class LogstashFormatter

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

net.logstash.logback.composite.CompositeJsonFormatter<ch.qos.logback.classic.spi.ILoggingEvent>

net.logstash.logback.composite.loggingevent.LoggingEventCompositeJsonFormatter

net.logstash.logback.LogstashFormatter

All Implemented Interfaces:

ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.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(ch.qos.logback.core.spi.ContextAware declaredOrigin)
LogstashFormatter(ch.qos.logback.core.spi.ContextAware declaredOrigin, boolean includeCallerInfo)
LogstashFormatter(ch.qos.logback.core.spi.ContextAware declaredOrigin, boolean includeCallerInfo, com.fasterxml.jackson.databind.JsonNode customFields)

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 void	configureProviderFieldNames()
com.fasterxml.jackson.databind.JsonNode	getCustomFields()
String	getCustomFieldsAsString()
List<String>	getExcludeMdcKeyNames()
LogstashFieldNames	getFieldNames()
List<String>	getIncludeMdcKeyNames()
LoggingEventJsonProviders	getProviders()
int	getShortenedLoggerNameLength()
ch.qos.logback.classic.pattern.ThrowableHandlingConverter	getThrowableConverter()
String	getTimeZone()
int	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	isWriteVersionAsString()
void	setCustomFields(com.fasterxml.jackson.databind.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	setProviders(JsonProviders<ch.qos.logback.classic.spi.ILoggingEvent> jsonProviders)
void	setShortenedLoggerNameLength(int length)
void	setThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)
void	setTimeZone(String timeZoneId)
void	setVersion(int version)
void	setWriteVersionAsString(boolean writeVersionAsString)
void	start()

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

getEncoding, getJsonFactory, getJsonFactoryDecorator, getJsonGeneratorDecorator, isStarted, prepareForDeferredProcessing, setEncoding, 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(ch.qos.logback.core.spi.ContextAware declaredOrigin)

LogstashFormatter

public LogstashFormatter(ch.qos.logback.core.spi.ContextAware declaredOrigin,
                 boolean includeCallerInfo)

LogstashFormatter

public LogstashFormatter(ch.qos.logback.core.spi.ContextAware declaredOrigin,
                 boolean includeCallerInfo,
                 com.fasterxml.jackson.databind.JsonNode customFields)

Method Detail

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class CompositeJsonFormatter<ch.qos.logback.classic.spi.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)

setIncludeCallerInfo

@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo)

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

getCustomFieldsAsString

public String getCustomFieldsAsString()

setCustomFieldsFromString

public void setCustomFieldsFromString(String customFields)

setCustomFields

public void setCustomFields(com.fasterxml.jackson.databind.JsonNode customFields)

getCustomFields

public com.fasterxml.jackson.databind.JsonNode getCustomFields()

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)

getThrowableConverter

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

setThrowableConverter

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

getVersion

public int getVersion()

setVersion

public void setVersion(int version)

isWriteVersionAsString

public boolean isWriteVersionAsString()

setWriteVersionAsString

public void setWriteVersionAsString(boolean writeVersionAsString)

isEnableContextMap

@Deprecated
public boolean isEnableContextMap()

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

setEnableContextMap

@Deprecated
public void setEnableContextMap(boolean enableContextMap)

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

addProvider

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

getProviders

public LoggingEventJsonProviders getProviders()

Overrides:

getProviders in class CompositeJsonFormatter<ch.qos.logback.classic.spi.ILoggingEvent>

getFieldNames

public LogstashFieldNames getFieldNames()

setFieldNames

public void setFieldNames(LogstashFieldNames fieldNames)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)

setProviders

public void setProviders(JsonProviders<ch.qos.logback.classic.spi.ILoggingEvent> jsonProviders)

Overrides:

setProviders in class LoggingEventCompositeJsonFormatter