This project adds graceful shutdown behavior to Spring Boot.
Multiple branches are maintained to support multiple Spring Boot versions. The following tables show the relation between the Spring Boot version and the Spring Boot Graceful Shutdown version.
Spring Boot | Spring Boot Graceful Shutdown | Branch |
---|---|---|
1.5.x | 1.0.x | 1.0.x |
2.0.x | 2.0.x | 2.0.x |
2.1.x | 2.1.x | 2.1.x |
2.2.x | 2.2.x | master |
Currently this project only supports Tomcat as embedded web container for Spring Boot. Undertow and/or Jetty are not yet supported.
<dependency>
<groupId>com.github.timpeeters</groupId>
<artifactId>spring-boot-graceful-shutdown</artifactId>
<version>X.X.X</version>
</dependency>
Key | Default value | Description |
---|---|---|
graceful.shutdown.enabled | false | Indicates whether graceful shutdown is enabled or not. |
graceful.shutdown.timeout | 60s | The time to wait for active threads to finish before shutting down the Tomcat connector. |
graceful.shutdown.wait | 30s | The time to return "out of service" on the health page before starting the graceful shutdown. |
It is important to specify the time unit, otherwise you end up with milliseconds.
We found several alternatives for graceful shutdown behavior in Spring Boot.