ch.qos.logback.contrib.json.access

Class JsonLayout

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

ch.qos.logback.contrib.json.JsonLayoutBase<ch.qos.logback.access.spi.IAccessEvent>

ch.qos.logback.contrib.json.access.JsonLayout

All Implemented Interfaces:

ch.qos.logback.core.Layout<ch.qos.logback.access.spi.IAccessEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class JsonLayout
extends JsonLayoutBase<ch.qos.logback.access.spi.IAccessEvent>

A JsonLayout builds its jsonMap from a source IAccessEvent with the following keys/value pairs:

Key	Value	Notes	Enabled by default?
timestamp	String value of IAccessEvent.getTimeStamp()	By default, the value is not formatted; it is simply String.valueOf(timestamp). To format the string using a SimpleDateFormat, set the timestampFormat property with the corresponding SimpleDateFormat string, for example, yyyy-MM-dd HH:mm:ss.SSS	true
remoteAddress	IAccessEvent.getRemoteAddr()	Internet Protocol (IP) address of the client or last proxy that sent the request.	true
remoteUser	IAccessEvent.getRemoteUser()		true
requestTime	String value of IAccessEvent.getElapsedTime()	The time elapsed between receiving the request and logging it. By default, the value is formatted as s.SSS	true
uri	IAccessEvent.getRequestURI()		true
status	String value of IAccessEvent.getStatusCode()		true
method	IAccessEvent.getMethod()		true
protocol	IAccessEvent.getProtocol()		true
contentLength	String value of IAccessEvent.getContentLength()		true
url	IAccessEvent.getRequestURL()		false
remoteHost	IAccessEvent.getRemoteHost()	Fully qualified name of the client or the last proxy that sent the request.	true
serverName	IAccessEvent.getServerName()	Name of the server to which the request was sent.	true
headers	IAccessEvent.getRequestHeaderMap()	This value is a Map<String,String>.	true
params	IAccessEvent.getRequestParameterMap()	This value is a Map<String,String>.	true
port	String value of IAccessEvent.getLocalPort()		false
requestContent	IAccessEvent.getRequestContent()		false
responseContent	IAccessEvent.getResponseContent()		false

Author:

Espen A. Fossen

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENTLENGTH_ATTR_NAME
protected boolean	includeContentLength
protected boolean	includeLocalPort
protected boolean	includeMethod
protected boolean	includeProtocol
protected boolean	includeRemoteAddr
protected boolean	includeRemoteHost
protected boolean	includeRemoteUser
protected boolean	includeRequestContent
protected boolean	includeRequestHeader
protected boolean	includeRequestParameter
protected boolean	includeRequestTime
protected boolean	includeRequestURI
protected boolean	includeRequestURL
protected boolean	includeResponseContent
protected boolean	includeServerName
protected boolean	includeStatusCode
static String	LOCALPORT_ATTR_NAME
static String	METHOD_ATTR_NAME
static String	PROTOCOL_ATTR_NAME
static String	REMOTEADDR_ATTR_NAME
static String	REMOTEHOST_ATTR_NAME
static String	REMOTEUSER_ATTR_NAME
static String	REQUESTCONTENT_ATTR_NAME
static String	REQUESTHEADER_ATTR_NAME
static String	REQUESTPARAMETER_ATTR_NAME
static String	REQUESTTIME_ATTR_NAME
static String	REQUESTURI_ATTR_NAME
static String	REQUESTURL_ATTR_NAME
static String	RESPONSECONTENT_ATTR_NAME
static String	SERVERNAME_ATTR_NAME
static String	STATUSCODE_ATTR_NAME
static String	TIMESTAMP_ATTR_NAME

Fields inherited from class ch.qos.logback.contrib.json.JsonLayoutBase

appendLineSeparator, CONTENT_TYPE, includeTimestamp, jsonFormatter, timestampFormat, timestampFormatTimezoneId

Fields inherited from class ch.qos.logback.core.LayoutBase

started

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

context

Constructor Summary

Constructors

Constructor and Description
JsonLayout()

Method Summary

Modifier and Type	Method and Description
protected void	addInt(String key, boolean field, int intValue, Map<String,Object> map)
protected void	addRequestTime(long requestTime, Map<String,Object> map)
boolean	isIncludeContentLength()
boolean	isIncludeLocalPort()
boolean	isIncludeMethod()
boolean	isIncludeProtocol()
boolean	isIncludeRemoteAddr()
boolean	isIncludeRemoteHost()
boolean	isIncludeRemoteUser()
boolean	isIncludeRequestContent()
boolean	isIncludeRequestHeader()
boolean	isIncludeRequestParameter()
boolean	isIncludeRequestTime()
boolean	isIncludeRequestURI()
boolean	isIncludeRequestURL()
boolean	isIncludeResponseContent()
boolean	isIncludeServerName()
boolean	isIncludeStatusCode()
void	setIncludeContentLength(boolean includeContentLength)
void	setIncludeLocalPort(boolean includeLocalPort)
void	setIncludeMethod(boolean includeMethod)
void	setIncludeProtocol(boolean includeProtocol)
void	setIncludeRemoteAddr(boolean includeRemoteAddr)
void	setIncludeRemoteHost(boolean includeRemoteHost)
void	setIncludeRemoteUser(boolean includeRemoteUser)
void	setIncludeRequestContent(boolean includeRequestContent)
void	setIncludeRequestHeader(boolean includeRequestHeader)
void	setIncludeRequestParameter(boolean includeRequestParameter)
void	setIncludeRequestTime(boolean includeRequestTime)
void	setIncludeRequestURI(boolean includeRequestURI)
void	setIncludeRequestURL(boolean includeRequestURL)
void	setIncludeResponseContent(boolean includeResponseContent)
void	setIncludeServerName(boolean includeServerName)
void	setIncludeStatusCode(boolean includeStatusCode)
protected Map	toJsonMap(ch.qos.logback.access.spi.IAccessEvent event)

Methods inherited from class ch.qos.logback.contrib.json.JsonLayoutBase

add, addMap, addTimestamp, createDateFormat, doLayout, format, formatTimestamp, getContentType, getJsonFormatter, getTimestampFormat, getTimestampFormatTimezoneId, isAppendLineSeparator, isIncludeTimestamp, setAppendLineSeparator, setIncludeTimestamp, setJsonFormatter, setTimestampFormat, setTimestampFormatTimezoneId

Methods inherited from class ch.qos.logback.core.LayoutBase

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

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

Field Detail

TIMESTAMP_ATTR_NAME

public static final String TIMESTAMP_ATTR_NAME

See Also:

Constant Field Values

REMOTEADDR_ATTR_NAME

public static final String REMOTEADDR_ATTR_NAME

See Also:

Constant Field Values

REMOTEUSER_ATTR_NAME

public static final String REMOTEUSER_ATTR_NAME

See Also:

Constant Field Values

REQUESTTIME_ATTR_NAME

public static final String REQUESTTIME_ATTR_NAME

See Also:

Constant Field Values

REQUESTURI_ATTR_NAME

public static final String REQUESTURI_ATTR_NAME

See Also:

Constant Field Values

STATUSCODE_ATTR_NAME

public static final String STATUSCODE_ATTR_NAME

See Also:

Constant Field Values

METHOD_ATTR_NAME

public static final String METHOD_ATTR_NAME

See Also:

Constant Field Values

PROTOCOL_ATTR_NAME

public static final String PROTOCOL_ATTR_NAME

See Also:

Constant Field Values

CONTENTLENGTH_ATTR_NAME

public static final String CONTENTLENGTH_ATTR_NAME

See Also:

Constant Field Values

REQUESTURL_ATTR_NAME

public static final String REQUESTURL_ATTR_NAME

See Also:

Constant Field Values

REMOTEHOST_ATTR_NAME

public static final String REMOTEHOST_ATTR_NAME

See Also:

Constant Field Values

SERVERNAME_ATTR_NAME

public static final String SERVERNAME_ATTR_NAME

See Also:

Constant Field Values

REQUESTHEADER_ATTR_NAME

public static final String REQUESTHEADER_ATTR_NAME

See Also:

Constant Field Values

REQUESTPARAMETER_ATTR_NAME

public static final String REQUESTPARAMETER_ATTR_NAME

See Also:

Constant Field Values

LOCALPORT_ATTR_NAME

public static final String LOCALPORT_ATTR_NAME

See Also:

Constant Field Values

REQUESTCONTENT_ATTR_NAME

public static final String REQUESTCONTENT_ATTR_NAME

See Also:

Constant Field Values

RESPONSECONTENT_ATTR_NAME

public static final String RESPONSECONTENT_ATTR_NAME

See Also:

Constant Field Values

includeRemoteAddr

protected boolean includeRemoteAddr

includeRemoteUser

protected boolean includeRemoteUser

includeRequestTime

protected boolean includeRequestTime

includeRequestURI

protected boolean includeRequestURI

includeStatusCode

protected boolean includeStatusCode

includeMethod

protected boolean includeMethod

includeProtocol

protected boolean includeProtocol

includeContentLength

protected boolean includeContentLength

includeRequestURL

protected boolean includeRequestURL

includeRemoteHost

protected boolean includeRemoteHost

includeServerName

protected boolean includeServerName

includeRequestHeader

protected boolean includeRequestHeader

includeRequestParameter

protected boolean includeRequestParameter

includeLocalPort

protected boolean includeLocalPort

includeRequestContent

protected boolean includeRequestContent

includeResponseContent

protected boolean includeResponseContent

Constructor Detail

JsonLayout

public JsonLayout()

Method Detail

toJsonMap

protected Map toJsonMap(ch.qos.logback.access.spi.IAccessEvent event)

Specified by:

toJsonMap in class JsonLayoutBase<ch.qos.logback.access.spi.IAccessEvent>

addRequestTime

protected void addRequestTime(long requestTime,
                              Map<String,Object> map)

addInt

protected void addInt(String key,
                      boolean field,
                      int intValue,
                      Map<String,Object> map)

isIncludeRemoteAddr

public boolean isIncludeRemoteAddr()

setIncludeRemoteAddr

public void setIncludeRemoteAddr(boolean includeRemoteAddr)

isIncludeRemoteUser

public boolean isIncludeRemoteUser()

setIncludeRemoteUser

public void setIncludeRemoteUser(boolean includeRemoteUser)

isIncludeRequestTime

public boolean isIncludeRequestTime()

setIncludeRequestTime

public void setIncludeRequestTime(boolean includeRequestTime)

isIncludeRequestURI

public boolean isIncludeRequestURI()

setIncludeRequestURI

public void setIncludeRequestURI(boolean includeRequestURI)

isIncludeStatusCode

public boolean isIncludeStatusCode()

setIncludeStatusCode

public void setIncludeStatusCode(boolean includeStatusCode)

isIncludeMethod

public boolean isIncludeMethod()

setIncludeMethod

public void setIncludeMethod(boolean includeMethod)

isIncludeProtocol

public boolean isIncludeProtocol()

setIncludeProtocol

public void setIncludeProtocol(boolean includeProtocol)

isIncludeContentLength

public boolean isIncludeContentLength()

setIncludeContentLength

public void setIncludeContentLength(boolean includeContentLength)

isIncludeRequestURL

public boolean isIncludeRequestURL()

setIncludeRequestURL

public void setIncludeRequestURL(boolean includeRequestURL)

isIncludeRemoteHost

public boolean isIncludeRemoteHost()

setIncludeRemoteHost

public void setIncludeRemoteHost(boolean includeRemoteHost)

isIncludeServerName

public boolean isIncludeServerName()

setIncludeServerName

public void setIncludeServerName(boolean includeServerName)

isIncludeRequestHeader

public boolean isIncludeRequestHeader()

setIncludeRequestHeader

public void setIncludeRequestHeader(boolean includeRequestHeader)

isIncludeRequestParameter

public boolean isIncludeRequestParameter()

setIncludeRequestParameter

public void setIncludeRequestParameter(boolean includeRequestParameter)

isIncludeLocalPort

public boolean isIncludeLocalPort()

setIncludeLocalPort

public void setIncludeLocalPort(boolean includeLocalPort)

isIncludeRequestContent

public boolean isIncludeRequestContent()

setIncludeRequestContent

public void setIncludeRequestContent(boolean includeRequestContent)

isIncludeResponseContent

public boolean isIncludeResponseContent()

setIncludeResponseContent

public void setIncludeResponseContent(boolean includeResponseContent)