Package 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
A
AccessEventCompositeJsonFormatter
that contains a common
pre-defined set of JsonProvider
s.
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
FieldsModifier and TypeFieldDescriptionprotected LogstashAccessFieldNames
The field names to use when writing the access event fieldsFields inherited from class ch.qos.logback.core.spi.ContextAwareBase
context
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addProvider
(JsonProvider<IAccessEvent> provider) protected void
boolean
boolean
boolean
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
-
Field Details
-
fieldNames
The field names to use when writing the access event fields
-
-
Constructor Details
-
LogstashAccessFormatter
-
-
Method Details
-
start
public void start()- Specified by:
start
in interfaceLifeCycle
- Overrides:
start
in classAbstractCompositeJsonFormatter<IAccessEvent>
-
configureProviderFieldNames
protected void configureProviderFieldNames() -
addProvider
-
getProviders
- Overrides:
getProviders
in classAbstractCompositeJsonFormatter<IAccessEvent>
-
getFieldNames
-
setFieldNames
-
getTimeZone
-
setTimeZone
-
getTimestampPattern
-
setTimestampPattern
-
getCustomFieldsAsString
-
setCustomFieldsFromString
-
setCustomFields
-
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
-
setRequestHeaderFilter
-
getResponseHeaderFilter
-
setResponseHeaderFilter
-
isIncludeContext
public boolean isIncludeContext() -
setIncludeContext
public void setIncludeContext(boolean includeContext) -
getMessagePattern
-
setMessagePattern
-
getVersion
-
setVersion
-
isWriteVersionAsInteger
public boolean isWriteVersionAsInteger() -
setWriteVersionAsInteger
public void setWriteVersionAsInteger(boolean writeVersionAsInteger) -
setProviders
- Overrides:
setProviders
in classAccessEventCompositeJsonFormatter
-