Graceful restart or stop

Do you want to graceful restart or stop your web server? There are some ways this can be done.

We can use fvbock/endless to replace the default ListenAndServe. Refer issue #296 for more details.

  1. router := gin.Default()
  2. router.GET("/", handler)
  3. // [...]
  4. endless.ListenAndServe(":4242", router)

An alternative to endless:

  • manners: A polite Go HTTP server that shuts down gracefully.
  • graceful: Graceful is a Go package enabling graceful shutdown of an http.Handler server.
  • grace: Graceful restart & zero downtime deploy for Go servers.

If you are using Go 1.8, you may not need to use this library! Consider using http.Server’s built-in Shutdown() method for graceful shutdowns. See the full graceful-shutdown example with gin.

  1. // +build go1.8
  3. package main
  5. import (
  6.     "context"
  7.     "log"
  8.     "net/http"
  9.     "os"
  10.     "os/signal"
  11.     "syscall"
  12.     "time"
  14.     "github.com/gin-gonic/gin"
  15. )
  17. func main() {
  18.     router := gin.Default()
  19.     router.GET("/", func(c *gin.Context) {
  20.         time.Sleep(5 * time.Second)
  21.         c.String(http.StatusOK, "Welcome Gin Server")
  22.     })
  24.     srv := &http.Server{
  25.         Addr:    ":8080",
  26.         Handler: router,
  27.     }
  29.     go func() {
  30.         // service connections
  31.         if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
  32.             log.Fatalf("listen: %s\n", err)
  33.         }
  34.     }()
  36.     // Wait for interrupt signal to gracefully shutdown the server with
  37.     // a timeout of 5 seconds.
  38.     quit := make(chan os.Signal)
  39.     // kill (no param) default send syscanll.SIGTERM
  40.     // kill -2 is syscall.SIGINT
  41.     // kill -9 is syscall. SIGKILL but can"t be catch, so don't need add it
  42.     signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
  43.     <-quit
  44.     log.Println("Shutdown Server ...")
  46.     ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
  47.     defer cancel()
  48.     if err := srv.Shutdown(ctx); err != nil {
  49.         log.Fatal("Server Shutdown:", err)
  50.     }
  51.     // catching ctx.Done(). timeout of 5 seconds.
  52.     select {
  53.     case <-ctx.Done():
  54.         log.Println("timeout of 5 seconds.")
  55.     }
  56.     log.Println("Server exiting")
  57. }

Last modified March 7, 2020 : add blog dir (#115) (f46734b)