REST Template Logging

Spring RestTemplate does support request/response logging but at a very primitive and unsatisfying level. Girders provides a LoggingClientHttpRequestInterceptor to support logging every request/response issued through a RestTemplate which was created using a RestTemplateBuilder.

WARNING: Be careful about logging all the REST requests and response. The payload might contain confidential information that must not be logged.

Add the module by including the following dependency in your POM:

<dependency>
  <groupId>com.netcetera.girders</groupId>
  <artifactId>girders-resttemplatelogging</artifactId>
</dependency>

To use this feature, you must first create a RestTemplate using the RestTemplateBuilder bean:

@Configuration
public class RestClientConfiguration {

  @Bean
  public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder) {
    // perform any further configuration on the builder, according to your needs
    return restTemplateBuilder.build();
  }
}

The created RestTemplate is automatically enhanced with the logging functionality and can now be used as usual within your code:

@Component
public class WeatherApiClient {

  private final RestTemplate restTemplate;

  public WeatherApiClient(RestTemplate restTemplate) {
    this.restTemplate = restTemplate;
  }

  public WeatherData getWeatherData() {
    return restTemplate.getForObject("http://api.openweathermap.org/data/2.5/weather?lat=1.234&lon=5.678", WeatherData.class);
  }
}

The HTTP request/response will be logged on TRACE level using a logger identified by the ClientHttpRequest.${host} key, where the ${host} part will be replaced by the actual hostname (or IP address) of the target host of the request. To enable the logging for a specific host, you must enable TRACE logging either by defining the following application property

logging.level.ClientHttpRequest.api.openweathermap.org=TRACE