Package com.linecorp.armeria.common.logback

Class RequestContextExportingAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.UnsynchronizedAppenderBase<ILoggingEvent>

com.linecorp.armeria.common.logback.RequestContextExportingAppender

All Implemented Interfaces:

Appender<ILoggingEvent>, AppenderAttachable<ILoggingEvent>, ContextAware, FilterAttachable<ILoggingEvent>, LifeCycle

public class RequestContextExportingAppender
extends UnsynchronizedAppenderBase<ILoggingEvent>
implements AppenderAttachable<ILoggingEvent>

A Logback Appender that exports the properties of the current RequestContext to MDC.

Read 'Logging contextual information' for more information.

Field Summary

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

name, started

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

context

Constructor Summary

Constructors

Constructor	Description
RequestContextExportingAppender()

Method Summary

Modifier and Type	Method	Description
void	addAppender(Appender<ILoggingEvent> newAppender)
void	addAttribute(String alias, AttributeKey<?> attrKey)	Adds the specified AttributeKey to the export list.
void	addAttribute(String alias, AttributeKey<?> attrKey, Function<?,String> stringifier)	Adds the specified AttributeKey to the export list.
void	addBuiltIn(BuiltInProperty property)	Adds the specified BuiltInProperty to the export list.
void	addHttpRequestHeader(CharSequence name)	Adds the specified HTTP request header name to the export list.
void	addHttpResponseHeader(CharSequence name)	Adds the specified HTTP response header name to the export list.
protected void	append(ILoggingEvent eventObject)
boolean	containsAttribute(AttributeKey<?> key)	Returns true if the specified AttributeKey is in the export list.
boolean	containsBuiltIn(BuiltInProperty property)	Returns true if the specified BuiltInProperty is in the export list.
boolean	containsHttpRequestHeader(CharSequence name)	Returns true if the specified HTTP request header name is in the export list.
boolean	containsHttpResponseHeader(CharSequence name)	Returns true if the specified HTTP response header name is in the export list.
void	detachAndStopAllAppenders()
boolean	detachAppender(Appender<ILoggingEvent> appender)
boolean	detachAppender(String name)
protected void	export(Map<String,String> out, com.linecorp.armeria.common.RequestContext ctx, com.linecorp.armeria.common.logging.RequestLog log)	Exports the necessary properties to MDC.
Appender<ILoggingEvent>	getAppender(String name)
Map<String,AttributeKey<?>>	getAttributes()	Returns all AttributeKeys in the export list.
Set<BuiltInProperty>	getBuiltIns()	Returns all BuiltInPropertys in the export list.
Set<AsciiString>	getHttpRequestHeaders()	Returns all HTTP request header names in the export list.
Set<AsciiString>	getHttpResponseHeaders()	Returns all HTTP response header names in the export list.
boolean	isAttached(Appender<ILoggingEvent> appender)
Iterator<Appender<ILoggingEvent>>	iteratorForAppenders()
void	setExport(String mdcKey)	Adds the property represented by the specified MDC key to the export list.
void	setExports(String mdcKeys)	Adds the properties represented by the specified comma-separated MDC keys to the export list.
void	start()
void	stop()

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

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

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, wait, wait, wait

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

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Constructor Detail

RequestContextExportingAppender

public RequestContextExportingAppender()

Method Detail

addBuiltIn

public void addBuiltIn(BuiltInProperty property)

Adds the specified BuiltInProperty to the export list.

containsBuiltIn

public boolean containsBuiltIn(BuiltInProperty property)

Returns true if the specified BuiltInProperty is in the export list.

getBuiltIns

public Set<BuiltInProperty> getBuiltIns()

Returns all BuiltInPropertys in the export list.

addAttribute

public void addAttribute(String alias,
                         AttributeKey<?> attrKey)

Adds the specified AttributeKey to the export list.

Parameters:

alias - the alias of the attribute to export

attrKey - the key of the attribute to export

addAttribute

public void addAttribute(String alias,
                         AttributeKey<?> attrKey,
                         Function<?,String> stringifier)

Adds the specified AttributeKey to the export list.

Parameters:

alias - the alias of the attribute to export

attrKey - the key of the attribute to export

stringifier - the Function that converts the attribute value into a String

containsAttribute

public boolean containsAttribute(AttributeKey<?> key)

Returns true if the specified AttributeKey is in the export list.

getAttributes

public Map<String,AttributeKey<?>> getAttributes()

Returns all AttributeKeys in the export list.

Returns:

the Map whose key is an alias and value is an AttributeKey

addHttpRequestHeader

public void addHttpRequestHeader(CharSequence name)

Adds the specified HTTP request header name to the export list.

addHttpResponseHeader

public void addHttpResponseHeader(CharSequence name)

Adds the specified HTTP response header name to the export list.

containsHttpRequestHeader

public boolean containsHttpRequestHeader(CharSequence name)

Returns true if the specified HTTP request header name is in the export list.

containsHttpResponseHeader

public boolean containsHttpResponseHeader(CharSequence name)

Returns true if the specified HTTP response header name is in the export list.

getHttpRequestHeaders

public Set<AsciiString> getHttpRequestHeaders()

Returns all HTTP request header names in the export list.

getHttpResponseHeaders

public Set<AsciiString> getHttpResponseHeaders()

Returns all HTTP response header names in the export list.

setExport

public void setExport(String mdcKey)

Adds the property represented by the specified MDC key to the export list. Note: this method is meant to be used for XML configuration. Use add*() methods instead.

setExports

public void setExports(String mdcKeys)

Adds the properties represented by the specified comma-separated MDC keys to the export list. Note: this method is meant to be used for XML configuration. Use add*() methods instead.

append

protected void append(ILoggingEvent eventObject)

Specified by:

append in class UnsynchronizedAppenderBase<ILoggingEvent>

export

protected void export(Map<String,String> out,
                      com.linecorp.armeria.common.RequestContext ctx,
                      com.linecorp.armeria.common.logging.RequestLog log)

Exports the necessary properties to MDC. By default, this method exports all properties added to the export list via add*() calls and <export /> tags. Override this method to export additional properties.

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class UnsynchronizedAppenderBase<ILoggingEvent>

stop

public void stop()

Specified by:

stop in interface LifeCycle

Overrides:

stop in class UnsynchronizedAppenderBase<ILoggingEvent>

addAppender

public void addAppender(Appender<ILoggingEvent> newAppender)

Specified by:

addAppender in interface AppenderAttachable<ILoggingEvent>

iteratorForAppenders

public Iterator<Appender<ILoggingEvent>> iteratorForAppenders()

Specified by:

iteratorForAppenders in interface AppenderAttachable<ILoggingEvent>

getAppender

public Appender<ILoggingEvent> getAppender(String name)

Specified by:

getAppender in interface AppenderAttachable<ILoggingEvent>

isAttached

public boolean isAttached(Appender<ILoggingEvent> appender)

Specified by:

isAttached in interface AppenderAttachable<ILoggingEvent>

detachAndStopAllAppenders

public void detachAndStopAllAppenders()

Specified by:

detachAndStopAllAppenders in interface AppenderAttachable<ILoggingEvent>

detachAppender

public boolean detachAppender(Appender<ILoggingEvent> appender)

Specified by:

detachAppender in interface AppenderAttachable<ILoggingEvent>

detachAppender

public boolean detachAppender(String name)

Specified by:

detachAppender in interface AppenderAttachable<ILoggingEvent>