Package com.linecorp.armeria.common.logging

Class RequestContextExporterBuilder

java.lang.Object

com.linecorp.armeria.common.logging.RequestContextExporterBuilder

public final class RequestContextExporterBuilder
extends Object

Builds a new RequestContextExporter.

Method Summary

Modifier and Type	Method	Description
RequestContextExporterBuilder	addAttribute(String alias, AttributeKey<?> attrKey)	Adds the specified AttributeKey to the export list.
RequestContextExporterBuilder	addAttribute(String alias, AttributeKey<?> attrKey, Function<?,String> stringifier)	Adds the specified AttributeKey to the export list.
RequestContextExporterBuilder	addBuiltIn(BuiltInProperty property)	Adds the specified BuiltInProperty to the export list.
RequestContextExporterBuilder	addBuiltIn(BuiltInProperty property, String alias)	Adds the specified BuiltInProperty to the export list.
RequestContextExporterBuilder	addKeyPattern(String keyPattern)	Adds the property represented by the specified key pattern to the export list.
RequestContextExporterBuilder	addRequestHeader(CharSequence headerName)	Adds the specified HTTP request header name to the export list.
RequestContextExporterBuilder	addRequestHeader(CharSequence headerName, String alias)	Adds the specified HTTP request header name to the export list.
RequestContextExporterBuilder	addResponseHeader(CharSequence headerName)	Adds the specified HTTP response header name to the export list.
RequestContextExporterBuilder	addResponseHeader(CharSequence headerName, String alias)	Adds the specified HTTP response header name to the export list.
RequestContextExporter	build()	Returns a newly-created RequestContextExporter instance.

Methods inherited from class java.lang.Object

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

Method Details

addBuiltIn

public RequestContextExporterBuilder addBuiltIn(BuiltInProperty property)

Adds the specified BuiltInProperty to the export list. The BuiltInProperty.key will be used for the export key.

addBuiltIn

public RequestContextExporterBuilder addBuiltIn(BuiltInProperty property, String alias)

Adds the specified BuiltInProperty to the export list. The specified alias will be used for the export key.

addAttribute

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

Adds the specified AttributeKey to the export list. The specified alias is used for the export key.

Parameters:

alias - the alias of the attribute to export

attrKey - the key of the attribute to export

addAttribute

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

Adds the specified AttributeKey to the export list. The specified alias is used for the export key.

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

addRequestHeader

public RequestContextExporterBuilder addRequestHeader(CharSequence headerName)

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

addRequestHeader

public RequestContextExporterBuilder addRequestHeader(CharSequence headerName, String alias)

Adds the specified HTTP request header name to the export list. The specified alias is used for the export key.

addResponseHeader

public RequestContextExporterBuilder addResponseHeader(CharSequence headerName)

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

addResponseHeader

public RequestContextExporterBuilder addResponseHeader(CharSequence headerName, String alias)

Adds the specified HTTP response header name to the export list. The specified alias is used for the export key.

addKeyPattern

public RequestContextExporterBuilder addKeyPattern(String keyPattern)

Adds the property represented by the specified key pattern to the export list. Please refer to the Logging contextual information in order to learn how to specify a key pattern.

build

public RequestContextExporter build()

Returns a newly-created RequestContextExporter instance.