net.logstash.logback

Class LogstashAccessFormatter

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

net.logstash.logback.composite.AbstractCompositeJsonFormatter<IAccessEvent>

net.logstash.logback.composite.accessevent.AccessEventCompositeJsonFormatter

net.logstash.logback.LogstashAccessFormatter

All Implemented Interfaces:

ContextAware, LifeCycle

public class LogstashAccessFormatter
extends AccessEventCompositeJsonFormatter

A AccessEventCompositeJsonFormatter 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 AccessEventCompositeJsonFormatter directly.

Field Summary

Fields

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

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

context

Constructor Summary

Constructors

Constructor and Description
LogstashAccessFormatter(ContextAware declaredOrigin)

Method Summary

Modifier and Type	Method and Description
void	addProvider(JsonProvider<IAccessEvent> provider)
protected void	configureProviderFieldNames()
JsonNode	getCustomFields()
String	getCustomFieldsAsString()
LogstashAccessFieldNames	getFieldNames()
boolean	getLowerCaseHeaderNames()
String	getMessagePattern()
AccessEventJsonProviders	getProviders()
HeaderFilter	getRequestHeaderFilter()
HeaderFilter	getResponseHeaderFilter()
String	getTimestampPattern()
String	getTimeZone()
String	getVersion()
boolean	isIncludeContext()
boolean	isWriteVersionAsInteger()
void	setCustomFields(JsonNode customFields)
void	setCustomFieldsFromString(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)
void	start()

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

getEncoding, getJsonFactory, getJsonFactoryDecorator, getJsonGeneratorDecorator, isFindAndRegisterJacksonModules, isStarted, prepareForDeferredProcessing, setEncoding, setFindAndRegisterJacksonModules, setJsonFactoryDecorator, setJsonGeneratorDecorator, stop, writeEvent, writeEventToGenerator

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 LogstashAccessFieldNames fieldNames

The field names to use when writing the access event fields

Constructor Detail

LogstashAccessFormatter

public LogstashAccessFormatter(ContextAware declaredOrigin)

Method Detail

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractCompositeJsonFormatter<IAccessEvent>

configureProviderFieldNames

protected void configureProviderFieldNames()

addProvider

public void addProvider(JsonProvider<IAccessEvent> provider)

getProviders

public AccessEventJsonProviders getProviders()

Overrides:

getProviders in class AbstractCompositeJsonFormatter<IAccessEvent>

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)

getCustomFieldsAsString

public String getCustomFieldsAsString()

setCustomFieldsFromString

public void setCustomFieldsFromString(String customFields)

setCustomFields

public void setCustomFields(JsonNode customFields)

getCustomFields

public JsonNode 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)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

getMessagePattern

public String getMessagePattern()

setMessagePattern

public void setMessagePattern(String messagePattern)

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 AccessEventCompositeJsonFormatter