Class LogstashAccessLayout

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.LayoutBase<IAccessEvent>

net.logstash.logback.layout.CompositeJsonLayout<IAccessEvent>

net.logstash.logback.layout.AccessEventCompositeJsonLayout

net.logstash.logback.layout.LogstashAccessLayout

All Implemented Interfaces:

Layout<IAccessEvent>, ContextAware, LifeCycle

public class LogstashAccessLayout
extends AccessEventCompositeJsonLayout

Field Summary

Fields inherited from class LayoutBase

started

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
LogstashAccessLayout()

Method Summary

Modifier and Type	Method	Description
void	addProvider(JsonProvider<IAccessEvent> provider)
protected AbstractCompositeJsonFormatter<IAccessEvent>	createFormatter()
String	getCustomFields()
LogstashAccessFieldNames	getFieldNames()
protected LogstashAccessFormatter	getFormatter()
boolean	getLowerCaseHeaderNames()
String	getMessagePattern()
HeaderFilter	getRequestHeaderFilter()
HeaderFilter	getResponseHeaderFilter()
String	getTimestampPattern()
String	getTimeZone()
String	getVersion()
boolean	isIncludeContext()
boolean	isWriteVersionAsInteger()
void	setCustomFields(String customFields)
void	setFieldNames(LogstashAccessFieldNames fieldNames)
void	setIncludeContext(boolean includeContext)
void	setLowerCaseHeaderNames(boolean lowerCaseHeaderNames)	When true, names of headers will be written to JSON output in lower case.
void	setMessagePattern(String messagePattern)
void	setProviders(JsonProviders<IAccessEvent> jsonProviders)
void	setRequestHeaderFilter(HeaderFilter filter)
void	setResponseHeaderFilter(HeaderFilter filter)
void	setTimestampPattern(String pattern)
void	setTimeZone(String timeZoneId)
void	setVersion(String version)
void	setWriteVersionAsInteger(boolean writeVersionAsInteger)

Methods inherited from class CompositeJsonLayout

addDecorator, doLayout, getDataFormat, getDataFormatFactory, getJsonGeneratorDecorator, getLineSeparator, getMapperBuilderDecorator, getMinBufferSize, getPrefix, getProviders, getSuffix, getTokenStreamFactoryBuilderDecorator, isImmediateFlush, setDataFormat, setDataFormatFactory, setFindAndRegisterJacksonModules, setImmediateFlush, setLineSeparator, setMinBufferSize, setPrefix, setSuffix, start, stop

Methods inherited from class LayoutBase

getContentType, getContext, getFileFooter, getFileHeader, getPresentationFooter, getPresentationHeader, isStarted, setContext, setFileFooter, setFileHeader, setPresentationFooter, setPresentationHeader

Methods inherited from class ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getDeclaredOrigin, getStatusManager

Methods inherited from class Object

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

Methods inherited from interface ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn

Constructor Details

LogstashAccessLayout

public LogstashAccessLayout()

Method Details

createFormatter

protected AbstractCompositeJsonFormatter<IAccessEvent> createFormatter()

Overrides:

createFormatter in class AccessEventCompositeJsonLayout

getFormatter

protected LogstashAccessFormatter getFormatter()

Overrides:

getFormatter in class CompositeJsonLayout<IAccessEvent>

addProvider

public void addProvider(JsonProvider<IAccessEvent> provider)

getFieldNames

public LogstashAccessFieldNames getFieldNames()

setFieldNames

public void setFieldNames(LogstashAccessFieldNames fieldNames)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)

getTimestampPattern

public String getTimestampPattern()

setTimestampPattern

public void setTimestampPattern(String pattern)

setCustomFields

public void setCustomFields(String customFields)

getCustomFields

public String getCustomFields()

getLowerCaseHeaderNames

public boolean getLowerCaseHeaderNames()

setLowerCaseHeaderNames

public void setLowerCaseHeaderNames(boolean lowerCaseHeaderNames)

When true, names of headers will be written to JSON output in lower case.

Parameters:

lowerCaseHeaderNames - When true, names of headers will be written to JSON output in lower case.

getRequestHeaderFilter

public HeaderFilter getRequestHeaderFilter()

setRequestHeaderFilter

public void setRequestHeaderFilter(HeaderFilter filter)

getResponseHeaderFilter

public HeaderFilter getResponseHeaderFilter()

setResponseHeaderFilter

public void setResponseHeaderFilter(HeaderFilter filter)

getMessagePattern

public String getMessagePattern()

setMessagePattern

public void setMessagePattern(String messagePattern)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

isWriteVersionAsInteger

public boolean isWriteVersionAsInteger()

setWriteVersionAsInteger

public void setWriteVersionAsInteger(boolean writeVersionAsInteger)

setProviders

public void setProviders(JsonProviders<IAccessEvent> jsonProviders)

Overrides:

setProviders in class AccessEventCompositeJsonLayout