Package com.linecorp.armeria.common.logging

Class TextLogFormatterBuilder

java.lang.Object

com.linecorp.armeria.common.logging.TextLogFormatterBuilder

@UnstableApi
public final class TextLogFormatterBuilder
extends Object

A builder implementation for TextLogFormatter.

Method Summary

Modifier and Type	Method	Description
LogFormatter	build()	Returns a newly-created text LogFormatter based on the properties of this builder.
TextLogFormatterBuilder	contentSanitizer(BiFunction<? super RequestContext,Object,? extends String> contentSanitizer)	Sets the BiFunction to use to sanitize request and response content before logging.
TextLogFormatterBuilder	headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> headersSanitizer)	Sets the BiFunction to use to sanitize request, response and trailers before logging.
TextLogFormatterBuilder	includeContext(boolean includeContext)	Sets whether to include stringified RequestContext in the result of LogFormatter.formatRequest(RequestOnlyLog) and LogFormatter.formatResponse(RequestLog).
TextLogFormatterBuilder	requestContentSanitizer(BiFunction<? super RequestContext,Object,? extends String> requestContentSanitizer)	Sets the BiFunction to use to sanitize request content before logging.
TextLogFormatterBuilder	requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> requestHeadersSanitizer)	Sets the BiFunction to use to sanitize request headers before logging.
TextLogFormatterBuilder	requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> requestTrailersSanitizer)	Sets the BiFunction to use to sanitize request trailers before logging.
TextLogFormatterBuilder	responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends String> responseContentSanitizer)	Sets the BiFunction to use to sanitize response content before logging.
TextLogFormatterBuilder	responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> responseHeadersSanitizer)	Sets the BiFunction to use to sanitize response headers before logging.
TextLogFormatterBuilder	responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> responseTrailersSanitizer)	Sets the BiFunction to use to sanitize response trailers before logging.

Methods inherited from class java.lang.Object

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

Method Details

includeContext

public TextLogFormatterBuilder includeContext(boolean includeContext)

Sets whether to include stringified RequestContext in the result of LogFormatter.formatRequest(RequestOnlyLog) and LogFormatter.formatResponse(RequestLog). The context is included by default.

build

public LogFormatter build()

Returns a newly-created text LogFormatter based on the properties of this builder.

requestHeadersSanitizer

public TextLogFormatterBuilder requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> requestHeadersSanitizer)

Sets the BiFunction to use to sanitize request headers before logging. It is common to have the BiFunction that removes sensitive headers, like Cookie, before logging. If unset, will not sanitize request headers.

 HeadersSanitizer<String> headersSanitizer =
   HeadersSanitizer
     .builderForText()
     .sensitiveHeaders("Authorization", "Cookie")
     ...
     .build();

  LogFormatter
    .builderForText()
    .requestHeadersSanitizer(headersSanitizer)
    ...
 

See Also:

• HeadersSanitizer

responseHeadersSanitizer

public TextLogFormatterBuilder responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> responseHeadersSanitizer)

Sets the BiFunction to use to sanitize response headers before logging. It is common to have the BiFunction that removes sensitive headers, like Set-Cookie, before logging. If unset, will not sanitize response headers.

 HeadersSanitizer<String> headersSanitizer =
   HeadersSanitizer
     .builderForText()
     .sensitiveHeaders("Set-Cookie")
     ...
     .build();

  LogFormatter
    .builderForText()
    .responseHeadersSanitizer(headersSanitizer)
    ...
 

See Also:

• HeadersSanitizer

requestTrailersSanitizer

public TextLogFormatterBuilder requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> requestTrailersSanitizer)

Sets the BiFunction to use to sanitize request trailers before logging. If unset, will not sanitize request trailers.

 HeadersSanitizer<String> headersSanitizer =
   HeadersSanitizer
     .builderForText()
     .sensitiveHeaders("...")
     ...
     .build();

  LogFormatter
    .builderForText()
    .requestTrailersSanitizer(headersSanitizer)
    ...
 

See Also:

• HeadersSanitizer

responseTrailersSanitizer

public TextLogFormatterBuilder responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> responseTrailersSanitizer)

Sets the BiFunction to use to sanitize response trailers before logging. If unset, will not sanitize response trailers.

 HeadersSanitizer<String> headersSanitizer =
   HeadersSanitizer
     .builderForText()
     .sensitiveHeaders("...")
     ...
     .build();

  LogFormatter
    .builderForText()
    .responseTrailersSanitizer(headersSanitizer)
    ...
 

See Also:

• HeadersSanitizer

headersSanitizer

public TextLogFormatterBuilder headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends String> headersSanitizer)

Sets the BiFunction to use to sanitize request, response and trailers before logging. It is common to have the BiFunction that removes sensitive headers, like "Cookie" and "Set-Cookie", before logging. This method is a shortcut for:

 HeadersSanitizer<String> headersSanitizer =
   HeadersSanitizer
     .builderForText()
     .sensitiveHeaders("...")
     ...
     .build();

 builder.requestHeadersSanitizer(headersSanitizer);
 builder.requestTrailersSanitizer(headersSanitizer);
 builder.responseHeadersSanitizer(headersSanitizer);
 builder.responseTrailersSanitizer(headersSanitizer);
 

See Also:

• HeadersSanitizer
• requestHeadersSanitizer(BiFunction)
• requestTrailersSanitizer(BiFunction)
• responseHeadersSanitizer(BiFunction)
• responseTrailersSanitizer(BiFunction)

requestContentSanitizer

public TextLogFormatterBuilder requestContentSanitizer(BiFunction<? super RequestContext,Object,? extends String> requestContentSanitizer)

Sets the BiFunction to use to sanitize request content before logging. It is common to have the BiFunction that removes sensitive content, such as an GPS location query, before logging. If unset, will not sanitize request content.

responseContentSanitizer

public TextLogFormatterBuilder responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends String> responseContentSanitizer)

Sets the BiFunction to use to sanitize response content before logging. It is common to have the BiFunction that removes sensitive content, such as an address, before logging. If unset, will not sanitize response content.

contentSanitizer

public TextLogFormatterBuilder contentSanitizer(BiFunction<? super RequestContext,Object,? extends String> contentSanitizer)

Sets the BiFunction to use to sanitize request and response content before logging. It is common to have the BiFunction that removes sensitive content, such as an GPS location query and an address, before logging. If unset, will not sanitize content. This method is a shortcut for:

 builder.requestContentSanitizer(contentSanitizer);
 builder.responseContentSanitizer(contentSanitizer);
 

See Also:

• requestContentSanitizer(BiFunction)
• responseContentSanitizer(BiFunction)