使用 Go 語言實現優雅的服務器重啟
使用 Go 語言實現優雅的服務器重啟
Go被設計為一種后臺語言,它通常也被用于后端程序中。服務端程序是GO語言最常見的軟件產品。在這我要解決的問題是:如何干凈利落地升級正在運行的服務端程序。
目標:
-
不關閉現有連接:例如我們不希望關掉已部署的運行中的程序。但又想不受限制地隨時升級服務。
-
socket連接要隨時響應用戶請求:任何時刻socket的關閉可能使用戶返回'連接被拒絕'的消息,而這是不可取的。
-
新的進程要能夠啟動并替換掉舊的。
原理
在基于Unix的操作系統中,signal(信號)是與長時間運行的進程交互的常用方法.
-
SIGTERM: 優雅地停止進程
-
SIGHUP: 重啟/重新加載進程 (例如: nginx, sshd, apache)
如果收到SIGHUP信號,優雅地重啟進程需要以下幾個步驟:
-
服務器要拒絕新的連接請求,但要保持已有的連接。
-
啟用新版本的進程
-
將socket“交給”新進程,新進程開始接受新連接請求
-
舊進程處理完畢后立即停止。
停止接受連接請求
服務器程序的共同點:持有一個死循環來接受連接請求:
for { conn, err := listener.Accept() // Handle connection}
跳出這個循環的最簡單方式是在socket監聽器上設置一個超時,當調用listener.SetTimeout(time.Now())后,listener.Accept()會立即返回一個timeout err,你可以捕獲并處理:
for { conn, err := listener.Accept() if err != nil { if nerr, ok := err.(net.Err); ok && nerr.Timeout() { fmt.Println(“Stop accepting connections”) return } }}
注意這個操作與關閉listener有所不同。這樣進程仍在監聽服務器端口,但連接請求會被操作系統的網絡棧排隊,等待一個進程接受它們。
啟動新進程
Go提供了一個原始類型ForkExec來產生新進程.你可以與這個新進程共享某些消息,例如文件描述符或環境參數。
execSpec := &syscall.ProcAttr{ Env: os.Environ(), Files: []uintptr{os.Stdin.Fd(), os.Stdout.Fd(), os.Stderr.Fd()}, }fork, err := syscall.ForkExec(os.Args[0], os.Args, execSpec)[…]
你會發現這個進程使用完全相同的參數os.Args啟動了一個新進程。
發送socket到子進程并恢復它
正如你先前看到的,你可以將文件描述符傳遞到新進程,這需要一些UNIX魔法(一切都是文件),我們可以把socket發送到新進程中,這樣新進程就能夠使用它并接收及等待新的連接。
但fork-execed進程需要知道它必須從文件中得到socket而不是新建一個(有些興許已經在使用了,因為我們還沒斷開已有的監聽)。你可以按任何你希望的方法來,最常見的是通過環境變量或命令行標志。
listenerFile, err := listener.File()if err != nil { log.Fatalln("Fail to get socket file descriptor:", err)}listenerFd := listenerFile.Fd()// Set a flag for the new process start processos.Setenv("_GRACEFUL_RESTART", "true")execSpec := &syscall.ProcAttr{ Env: os.Environ(), Files: []uintptr{os.Stdin.Fd(), os.Stdout.Fd(), os.Stderr.Fd(), listenerFd},}// Fork exec the new version of your serverfork, err := syscall.ForkExec(os.Args[0], os.Args, execSpec)
然后在程序的開始處:
var listener *net.TCPListenerif os.Getenv("_GRACEFUL_RESTART") == "true" { file := os.NewFile(3, "/tmp/sock-go-graceful-restart") listener, err := net.FileListener(file) if err != nil { // handle } var bool ok listener, ok = listener.(*net.TCPListener) if !ok { // handle }} else { listener, err = newListenerWithPort(12345)}
文件描述沒有被隨機的選擇為3,這是因為uintptr的切片已經發送了fork,監聽獲取了索引3。留意隱式聲明問題。
最后一步,等待舊服務連接停止
到此為止,就這樣,我們已經將其傳到另一個正在正確運行的進程,對于舊服務器的最后操作是等其連接關閉。由于標準庫里提供了sync.WaitGroup結構體,用go實現這個功能很簡單。
每次接收一個連接,在WaitGroup上加1,然后,我們在它完成時將計數器減一:
for { conn, err := listener.Accept() wg.Add(1) go func() { handle(conn) wg.Done() }()}
至于等待連接的結束,你僅需要wg.Wait(),因為沒有新的連接,我們等待wg.Done()已經被所有正在運行的handler調用。
Bonus: 不要無限制等待,給定限量的時間
有time.Timer,實現很簡單:
timeout := time.NewTimer(time.Minute)wait := make(chan struct{})go func() { wg.Wait() wait <- struct{}{}}()select {case <-timeout.C: return WaitTimeoutErrorcase <-wait: return nil}
完整的示例
這篇文章中的代碼片段都是從這個完整的示例中提取的:https://github.com/Scalingo/go-graceful-restart-example
結論
socket傳遞配合ForkExec使用確實是一種無干擾更新進程的有效方式,在最大時間上,新的連接會等待幾毫秒——用于服務的啟動和恢復socket,但這個時間很短。
這篇文章是我#周五技術系列的一部分,下這個周不會有新的更新了,大家圣誕節快樂。
鏈接:
-
Go變量的隱形聲明: http://www.qureet.com/blog/golang-beartrap/
-
Bonus的問題:fork()Golang進程安全嗎? : https://groups.google.com/forum/#!msg/golang-nuts/beKfn7rujNg/zwY6zwl7QtQJ
-
我們的網站: https://appsdeck.eu
— Léo Unbekandt CTO @ Appsdeck