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 process
os.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 server
fork, err := syscall.ForkExec(os.Args[0], os.Args, execSpec)
然後在程式的開始處:
複製代碼 代碼如下:
var listener *net.TCPListener
if os.Getenv("_GRACEFUL_RESTART") == "true" {
// The second argument should be the filename of the file descriptor
// however, a socker is not a named file but we should fit the interface
// of the os.NewFile function.
file := os.NewFile(3, "")
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: 不要無限制等待,給定限量的時間
複製代碼 代碼如下:
timeout := time.NewTimer(time.Minute)
wait := make(chan struct{})
go func() {
wg.Wait()
wait <- struct{}{}
}()
select {
case <-timeout.C:
return WaitTimeoutError
case <-wait:
return nil
}
完整的樣本
這篇文章中的程式碼片段都是從這個完整的樣本中提取的:https://github.com/Scalingo/go-graceful-restart-example
結論
socket傳遞配合ForkExec使用確實是一種無幹擾更新進程的有效方式,在最大時間上,新的串連會等待幾毫秒——用於服務的啟動和恢複socket,但這個時間很短。