Francisco Dorado
Francisco Dorado Software Architect at sngular.com in Seville. Specialised in backend technologies based in the Java ecosystem. Currently working on Microservices using Spring Framework and AWS Cloud technologies

Logging of Requests and Responses in Spring with Undertow (no body)

Logging of Requests and Responses in Spring with Undertow (no body)

Summary

In this post we’re going to configure Undertow as embedded server in our Spring Boot Application. Then we’ll trace in logs all the requests and responses of our controllers.

Configuring Undertow

Add the Undertow dependency to our Spring Boot Application and exclude tomcat in your pom.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<dependency>
	<groupId>org.springframework.boot</groupId>
  	<artifactId>spring-boot-starter-web</artifactId>
	<exclusions>
    	<exclusion>
      		<groupId>org.springframework.boot</groupId>
      		<artifactId>spring-boot-starter-tomcat</artifactId>
    	</exclusion>
  	</exclusions>
</dependency>

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

Enable RequestDumpingHandler adding the configuration bean of Undertow

In Spring boot < 2.0

1
2
3
4
5
6
7
8
9
10

@Bean
public UndertowEmbeddedServletContainerFactory undertowEmbeddedServletContainerFactory() {
    UndertowEmbeddedServletContainerFactory factory = new UndertowEmbeddedServletContainerFactory();
    factory.addDeploymentInfoCustomizers(deploymentInfo -> 
           	deploymentInfo.addInitialHandlerChainWrapper(handler -> {
    	return new RequestDumpingHandler(handler);
    }));
        
    return factory;
}

In Spring boot >= 2.0

1
2
3
4
5
6
7
8
9
10

@Bean
public UndertowServletWebServerFactory undertowServletWebServerFactory() {
    UndertowServletWebServerFactory factory = new UndertowServletWebServerFactory();
    factory.addDeploymentInfoCustomizers(deploymentInfo -> 
           	deploymentInfo.addInitialHandlerChainWrapper(handler -> {
    	return new RequestDumpingHandler(handler);
    }));
        
    return factory;
}

The result

Now when we invoke our controller we will see a result like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

2018-10-25 19:54:49.900  INFO 81483 --- [  XNIO-2 task-3] io.undertow.request.dump: 
----------------------------REQUEST---------------------------
               URI=/songs
 characterEncoding=null
     contentLength=-1
       contentType=null
            cookie=JSESSIONID=OxiTJHfy8yqLY3yT8scMfirBMRcl-imcPTcCDpYe
            header=Postman-Token=a80517f2-dd94-4f96-ac5d-e859c66343a1
            header=Accept=*/*
            header=Connection=keep-alive
            header=cache-control=no-cache
            header=accept-encoding=gzip, deflate
            header=cookie=JSESSIONID=OxiTJHfy8yqLY3yT8scMfirBMRcl-imcPTcCDpYe
            header=User-Agent=PostmanRuntime/7.3.0
            header=Host=localhost:8080
            locale=[]
            method=GET
          protocol=HTTP/1.1
       queryString=
        remoteAddr=/0:0:0:0:0:0:0:1:58800
        remoteHost=localhost
            scheme=http
              host=localhost:8080
        serverPort=8080
          isSecure=false
--------------------------RESPONSE--------------------------
     contentLength=-1
       contentType=application/json;charset=UTF-8
            header=Connection=keep-alive
            header=Transfer-Encoding=chunked
            header=Content-Type=application/json;charset=UTF-8
            header=Date=Thu, 25 Oct 2018 17:54:49 GMT
            status=200

==============================================================

References

[1] Link to the project in Github

comments powered by Disqus