Go 語言搭配 Docker Healthy Check 檢查

在 Docker 1.12 版本後，提供了 HEALTHCHECK 指令，通過指定的一行命令來判斷容器內的服務是否正常運作。在此之前大部分都是透過判斷程式是否 Crash 來決定容器是否存活，但是這地方有點風險的是，假設服務並非 crash，而是沒辦法退出容器，造成無法接受新的請求，這就確保容器存活。現在呢我們可以透過在 Dockerfile 內指定 HEALTHCHECK 指令來確保服務是否正常。而用 Go 語言開發的 Web 服務該如何來實現呢？

建立 /healthz 路由

透過簡單的路由 /healthz 直接回傳 200 status code 即可 (使用 Gin 當例子)。

1
2
3

func heartbeatHandler(c *gin.Context) {
  c.AbortWithStatus(http.StatusOK)
}

透過瀏覽器 http://localhost:8080/healthz 可以得到空白網頁，但是打開 console 可以看到正確回傳值。

建立 ping 指令

透過 net/http 套件可以快速寫個驗證接口的函式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

func pinger() error {
  resp, err := http.Get("http://localhost:8080/healthz")
  if err != nil {
    return err
  }
  defer resp.Body.Close()
  if resp.StatusCode != 200 {
    return fmt.Errorf("server returned non-200 status code")
  }
  return nil
}

增加 HEALTHCHECK 指令

在 Dockerfile 內增加底下內容:

1
2

HEALTHCHECK --start-period=2s --interval=10s --timeout=5s \
  CMD ["/bin/gorush", "--ping"]

• –start-period: 容器啟動後需要等待幾秒，預設為 0 秒
• –interval: 偵測間隔時間，預設為 30 秒
• –timeout: 檢查超時時間

重新編譯容器，並且啟動容器，會看到初始狀態為 (health: starting)

經過 10 秒後，就會執行指定的指令，就可以知道容器健康與否，最後狀態為 (healtyy)。

最後可以透過 docker inspect 指令來知道容器的狀態列表 (JSON 格式)

1

docker inspect --format '{{json .State.Health}}' gorush | jq

從上圖可以知道每隔 10 秒 Docker 就會自動偵測一次。有了上述這些資料，就可以來寫系統報警通知了。如果對 Go 語言有興趣，可以參考線上課程。