io.dropwizard.logging.json

Class AbstractJsonLayoutBaseFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>

java.lang.Object

io.dropwizard.logging.json.AbstractJsonLayoutBaseFactory<E>

All Implemented Interfaces:

Discoverable, DiscoverableLayoutFactory<E>

Direct Known Subclasses:

AccessJsonLayoutBaseFactory, EventJsonLayoutBaseFactory

public abstract class AbstractJsonLayoutBaseFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends Object
implements DiscoverableLayoutFactory<E>

Name	Default	Description
timestampFormat	(none)	By default, the timestamp is not formatted; To format the timestamp using set the property with the corresponding DateTimeFormatter string, for example, yyyy-MM-ddTHH:mm:ss.SSSZ
prettyPrint	false	Whether the JSON output should be formatted for human readability.
appendLineSeparator	true	Whether to append a line separator at the end of the message formatted as JSON.
customFieldNames	empty	A map of field name replacements. For example: (requestTime:request_time, userAgent:user_agent)
additionalFields	empty	A map of fields to add.

Constructor Summary

Constructors

Constructor and Description
AbstractJsonLayoutBaseFactory()

Method Summary

Modifier and Type	Method and Description
protected JsonFormatter	createDropwizardJsonFormatter()
protected TimestampFormatter	createTimestampFormatter(TimeZone timeZone)
Map<String,Object>	getAdditionalFields()
Map<String,String>	getCustomFieldNames()
String	getTimestampFormat()
boolean	isAppendLineSeparator()
boolean	isPrettyPrint()
void	setAdditionalFields(Map<String,Object> additionalFields)
void	setAppendLineSeparator(boolean appendLineSeparator)
void	setCustomFieldNames(Map<String,String> customFieldNames)
void	setPrettyPrint(boolean prettyPrint)
void	setTimestampFormat(String timestampFormat)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.dropwizard.logging.layout.DiscoverableLayoutFactory

build

Constructor Detail

AbstractJsonLayoutBaseFactory

public AbstractJsonLayoutBaseFactory()

Method Detail

getTimestampFormat

@Nullable
public String getTimestampFormat()

setTimestampFormat

public void setTimestampFormat(String timestampFormat)

isPrettyPrint

public boolean isPrettyPrint()

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

isAppendLineSeparator

public boolean isAppendLineSeparator()

setAppendLineSeparator

public void setAppendLineSeparator(boolean appendLineSeparator)

getCustomFieldNames

public Map<String,String> getCustomFieldNames()

setCustomFieldNames

public void setCustomFieldNames(Map<String,String> customFieldNames)

getAdditionalFields

public Map<String,Object> getAdditionalFields()

setAdditionalFields

public void setAdditionalFields(Map<String,Object> additionalFields)

createDropwizardJsonFormatter

protected JsonFormatter createDropwizardJsonFormatter()

createTimestampFormatter

protected TimestampFormatter createTimestampFormatter(TimeZone timeZone)