go gin framework graceful shutdown 예제

https://gin-gonic.com/docs/examples/graceful-restart-or-stop/

Graceful restart or stop

gin은 golang에서 많이 쓰이는 웹프레임워크입니다. graceful shutdown을 적용 유무에 따른 동작 방식을 알아보고자 합니다.

 

1) graceful shutdown 적용한 경우

package main

import (
	"context"
	"log"
	"net/http"
	"os"
	"os/signal"
	"syscall"
	"time"

	"github.com/gin-gonic/gin"
)

func main() {
	router := gin.Default()
	router.GET("/", func(c *gin.Context) {
		time.Sleep(5 * time.Second)
		c.String(http.StatusOK, "Welcome Gin Server")
	})

	srv := &http.Server{
		Addr:    ":8080",
		Handler: router,
	}

	go func() {
		// service connections
		if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
			log.Fatalf("listen: %s\n", err)
		}
	}()

	// Wait for interrupt signal to gracefully shutdown the server with
	// a timeout of 5 seconds.
	quit := make(chan os.Signal)
	// kill (no param) default send syscanll.SIGTERM
	// kill -2 is syscall.SIGINT
	// kill -9 is syscall. SIGKILL but can"t be catch, so don't need add it
	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
	<-quit
	log.Println("Shutdown Server ...")

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()
	if err := srv.Shutdown(ctx); err != nil {
		log.Fatal("Server Shutdown:", err)
	}
	// catching ctx.Done(). timeout of 5 seconds.
	select {
	case <-ctx.Done():
		log.Println("timeout of 5 seconds.")
	}
	log.Println("Server exiting")
}

실행 후 localhost:8080에 호출을 수행합니다.

$ curl localhost:8080/

이후 해당 process를 찾아 kill -term 명령어를 내리면

$ kill -term 80021

다음과 같은 로그와 함께 안전하게 종료됩니다.

2021/03/03 22:16:23 Shutdown Server ...
[GIN] 2021/03/03 - 22:16:27 | 200 |  5.000389654s |       127.0.0.1 | GET      "/"
2021/03/03 22:16:28 timeout of 5 seconds.
2021/03/03 22:16:28 Server exiting

이와 동시에 안전하게 종료되기 전 요청에 대해서 리턴을 수행합니다. 그렇기 때문에 요청이 끊키지 않습니다.

Welcome Gin Server

2) graceful shutdown 적용하지 않은 경우

package main

import (
	"net/http"
	"time"

	"github.com/gin-gonic/gin"
)

func main() {
	router := gin.Default()
	router.GET("/", func(c *gin.Context) {
		time.Sleep(5 * time.Second)
		c.String(http.StatusOK, "Welcome Gin Server")
	})

	err := router.Run(":8080")
	if err != nil {
		panic(err)
		return
	}
}

실행 후 localhost:8080에 호출을 수행합니다.

$ curl localhost:8080

이후 해당 process를 찾아 kill -term 명령어를 내리면

$ kill -term 80529

다음과 같이 에러가 발생하고 원치 않은 리턴값이 노출됩니다.

$ curl localhost:8080/
curl: (52) Empty reply from server