LoggingRpcClientBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
- - com.linecorp.armeria.client.logging.LoggingRpcClientBuilder

public final class LoggingRpcClientBuilder
extends LoggingDecoratorBuilder

Builds a new LoggingRpcClient.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoggingRpcClient`	`build(RpcClient delegate)` Returns a newly-created `LoggingRpcClient` decorating `delegate` based on the properties of this builder.
`LoggingRpcClientBuilder`	`contentSanitizer(Function<Object,?> contentSanitizer)` Sets the `Function` to use to sanitize request and response content before logging.
`LoggingRpcClientBuilder`	`failureResponseLogLevel(LogLevel failedResponseLogLevel)` Sets the `LogLevel` to use when logging failure responses (e.g., failed with an exception).
`LoggingRpcClientBuilder`	`headersSanitizer(Function<? super HttpHeaders,?> headersSanitizer)` Sets the `Function` to use to sanitize request, response and trailers before logging.
`LoggingRpcClientBuilder`	`logger(org.slf4j.Logger logger)` Sets the `Logger` to use when logging.
`Function<? super RpcClient,LoggingRpcClient>`	`newDecorator()` Returns a newly-created `LoggingRpcClient` decorator based on the properties of this builder.
`LoggingRpcClientBuilder`	`requestContentSanitizer(Function<Object,?> requestContentSanitizer)` Sets the `Function` to use to sanitize request content before logging.
`LoggingRpcClientBuilder`	`requestHeadersSanitizer(Function<? super HttpHeaders,?> requestHeadersSanitizer)` Sets the `Function` to use to sanitize request headers before logging.
`LoggingRpcClientBuilder`	`requestLogLevel(LogLevel requestLogLevel)` Sets the `LogLevel` to use when logging requests.
`LoggingRpcClientBuilder`	`requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)` Sets the `Function` to use when mapping the log level of request logs.
`LoggingRpcClientBuilder`	`requestTrailersSanitizer(Function<? super HttpHeaders,?> requestTrailersSanitizer)` Sets the `Function` to use to sanitize request trailers before logging.
`LoggingRpcClientBuilder`	`responseCauseSanitizer(Function<? super Throwable,?> responseCauseSanitizer)` Sets the `Function` to use to sanitize a response cause before logging.
`LoggingRpcClientBuilder`	`responseContentSanitizer(Function<Object,?> responseContentSanitizer)` Sets the `Function` to use to sanitize response content before logging.
`LoggingRpcClientBuilder`	`responseHeadersSanitizer(Function<? super HttpHeaders,?> responseHeadersSanitizer)` Sets the `Function` to use to sanitize response headers before logging.
`LoggingRpcClientBuilder`	`responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)` Sets the `Function` to use when mapping the log level of response logs.
`LoggingRpcClientBuilder`	`responseTrailersSanitizer(Function<? super HttpHeaders,?> responseTrailersSanitizer)` Sets the `Function` to use to sanitize response trailers before logging.
`LoggingRpcClientBuilder`	`sampler(Sampler<? super ClientRequestContext> sampler)` Sets the `Sampler` that determines which request needs logging.
`LoggingRpcClientBuilder`	`samplingRate(float samplingRate)` Sets the rate at which to sample requests to log.
`LoggingRpcClientBuilder`	`successfulResponseLogLevel(LogLevel successfulResponseLogLevel)` Sets the `LogLevel` to use when logging successful responses (e.g., no unhandled exception).

Methods inherited from class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
failedResponseLogLevel, logger, requestContentSanitizer, requestHeadersSanitizer, requestLogLevel, requestLogLevelMapper, requestTrailersSanitizer, responseCauseSanitizer, responseContentSanitizer, responseHeadersSanitizer, responseLogLevelMapper, responseTrailersSanitizer, successfulResponseLogLevel, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - build
```
public LoggingRpcClient build(RpcClient delegate)
```
    Returns a newly-created LoggingRpcClient decorating delegate based on the properties of this builder.
  - newDecorator
```
public Function<? super RpcClient,LoggingRpcClient> newDecorator()
```
    Returns a newly-created LoggingRpcClient decorator based on the properties of this builder.
  - samplingRate
```
public LoggingRpcClientBuilder samplingRate(float samplingRate)
```
    Sets the rate at which to sample requests to log. Any number between 0.0 and 1.0 will cause a random sample of the requests to be logged.
  - sampler
```
public LoggingRpcClientBuilder sampler(Sampler<? super ClientRequestContext> sampler)
```
    Sets the Sampler that determines which request needs logging.
  - logger
```
public LoggingRpcClientBuilder logger(org.slf4j.Logger logger)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Logger to use when logging. If unset, a default Logger will be used.
    
    Overrides:
    
    logger in class LoggingDecoratorBuilder
  - requestLogLevel
```
public LoggingRpcClientBuilder requestLogLevel(LogLevel requestLogLevel)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the LogLevel to use when logging requests. If unset, will use LogLevel.TRACE.
    
    Overrides:
    
    requestLogLevel in class LoggingDecoratorBuilder
  - successfulResponseLogLevel
```
public LoggingRpcClientBuilder successfulResponseLogLevel(LogLevel successfulResponseLogLevel)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception). If unset, will use LogLevel.TRACE.
    
    Overrides:
    
    successfulResponseLogLevel in class LoggingDecoratorBuilder
  - failureResponseLogLevel
```
public LoggingRpcClientBuilder failureResponseLogLevel(LogLevel failedResponseLogLevel)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the LogLevel to use when logging failure responses (e.g., failed with an exception). If unset, will use LogLevel.WARN. The request will be logged too if it was not otherwise.
    
    Overrides:
    
    failureResponseLogLevel in class LoggingDecoratorBuilder
  - requestLogLevelMapper
```
public LoggingRpcClientBuilder requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use when mapping the log level of request logs.
    
    Overrides:
    
    requestLogLevelMapper in class LoggingDecoratorBuilder
  - responseLogLevelMapper
```
public LoggingRpcClientBuilder responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use when mapping the log level of response logs.
    
    Overrides:
    
    responseLogLevelMapper in class LoggingDecoratorBuilder
  - requestHeadersSanitizer
```
public LoggingRpcClientBuilder requestHeadersSanitizer(Function<? super HttpHeaders,?> requestHeadersSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize request headers before logging. It is common to have the Function that removes sensitive headers, like Cookie, before logging. If unset, will use Function.identity().
    
    Overrides:
    
    requestHeadersSanitizer in class LoggingDecoratorBuilder
  - responseHeadersSanitizer
```
public LoggingRpcClientBuilder responseHeadersSanitizer(Function<? super HttpHeaders,?> responseHeadersSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize response headers before logging. It is common to have the Function that removes sensitive headers, like Set-Cookie, before logging. If unset, will use Function.identity().
    
    Overrides:
    
    responseHeadersSanitizer in class LoggingDecoratorBuilder
  - requestTrailersSanitizer
```
public LoggingRpcClientBuilder requestTrailersSanitizer(Function<? super HttpHeaders,?> requestTrailersSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize request trailers before logging. If unset, will use Function.identity().
    
    Overrides:
    
    requestTrailersSanitizer in class LoggingDecoratorBuilder
  - responseTrailersSanitizer
```
public LoggingRpcClientBuilder responseTrailersSanitizer(Function<? super HttpHeaders,?> responseTrailersSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize response trailers before logging. If unset, will use Function.identity().
    
    Overrides:
    
    responseTrailersSanitizer in class LoggingDecoratorBuilder
  - headersSanitizer
```
public LoggingRpcClientBuilder headersSanitizer(Function<? super HttpHeaders,?> headersSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    Sets the Function to use to sanitize request, response and trailers before logging. It is common to have the Function that removes sensitive headers, like "Cookie" and "Set-Cookie", before logging. This method is a shortcut for:
```
 builder.requestHeadersSanitizer(headersSanitizer);
 builder.requestTrailersSanitizer(headersSanitizer);
 builder.responseHeadersSanitizer(headersSanitizer);
 builder.responseTrailersSanitizer(headersSanitizer);
 
```
    Overrides:
    
    headersSanitizer in class LoggingDecoratorBuilder
    
    See Also:
    
    LoggingDecoratorBuilder.requestHeadersSanitizer(Function), LoggingDecoratorBuilder.requestTrailersSanitizer(Function), LoggingDecoratorBuilder.responseHeadersSanitizer(Function), LoggingDecoratorBuilder.responseTrailersSanitizer(Function)
  - requestContentSanitizer
```
public LoggingRpcClientBuilder requestContentSanitizer(Function<Object,?> requestContentSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize request content before logging. It is common to have the Function that removes sensitive content, such as an GPS location query, before logging. If unset, will use Function.identity().
    
    Overrides:
    
    requestContentSanitizer in class LoggingDecoratorBuilder
  - responseContentSanitizer
```
public LoggingRpcClientBuilder responseContentSanitizer(Function<Object,?> responseContentSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize response content before logging. It is common to have the Function that removes sensitive content, such as an address, before logging. If unset, will use Function.identity().
    
    Overrides:
    
    responseContentSanitizer in class LoggingDecoratorBuilder
  - contentSanitizer
```
public LoggingRpcClientBuilder contentSanitizer(Function<Object,?> contentSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    Sets the Function to use to sanitize request and response content before logging. It is common to have the Function that removes sensitive content, such as an GPS location query and an address, before logging. If unset, will use Function.identity(). This method is a shortcut for:
```
 builder.requestContentSanitizer(contentSanitizer);
 builder.responseContentSanitizer(contentSanitizer);
 
```
    Overrides:
    
    contentSanitizer in class LoggingDecoratorBuilder
    
    See Also:
    
    LoggingDecoratorBuilder.requestContentSanitizer(Function), LoggingDecoratorBuilder.responseContentSanitizer(Function)
  - responseCauseSanitizer
```
public LoggingRpcClientBuilder responseCauseSanitizer(Function<? super Throwable,?> responseCauseSanitizer)
```
    Description copied from class: LoggingDecoratorBuilder
    
    Sets the Function to use to sanitize a response cause before logging. You can sanitize the stack trace of the exception to remove sensitive information, or prevent from logging the stack trace completely by returning null in the Function. If unset, will use Function.identity().
    
    Overrides:
    
    responseCauseSanitizer in class LoggingDecoratorBuilder

Class LoggingRpcClientBuilder

Method Summary

Methods inherited from class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder

Methods inherited from class java.lang.Object

Method Detail

build

newDecorator

samplingRate

sampler

logger

requestLogLevel

successfulResponseLogLevel

failureResponseLogLevel

requestLogLevelMapper

responseLogLevelMapper

requestHeadersSanitizer

responseHeadersSanitizer

requestTrailersSanitizer

responseTrailersSanitizer

headersSanitizer

requestContentSanitizer

responseContentSanitizer

contentSanitizer

responseCauseSanitizer