千家信息网

Golang中如何实现平滑重启

发表于:2024-12-13 作者:千家信息网编辑
千家信息网最后更新 2024年12月13日,小编给大家分享一下Golang中如何实现平滑重启,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!与重载配置相同的是我们也需要
千家信息网最后更新 2024年12月13日Golang中如何实现平滑重启

小编给大家分享一下Golang中如何实现平滑重启,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!

与重载配置相同的是我们也需要通过信号来通知server重启,但关键在于平滑重启,如果只是简单的重启,只需要kill掉,然后再拉起即可。平滑重启意味着server升级的时候可以不用停止业务。

我们先来看下Github上有没有相应的库解决这个问题,然后找到了如下三个库:

  • facebookgo/grace - Graceful restart & zero downtime deploy for Go servers.

  • fvbock/endless - Zero downtime restarts for go servers (Drop in replacement for http.ListenAndServe)

  • jpillora/overseer - Monitorable, gracefully restarting, self-upgrading binaries in Go (golang)

我们分别来学习一下,下面只讲解http server的重启。

使用方式

我们来分别使用这三个库来做平滑重启的事情,之后来对比其优缺点。

这三个库的官方都给了相应的例子,例子如下:

但三个库官方的例子不太一致,我们来统一一下:

  • grace例子 https://github.com/facebookgo/grace/blob/master/gracedemo/demo.go

  • endless例子 https://github.com/fvbock/endless/tree/master/examples

  • overseer例子 https://github.com/jpillora/overseer/tree/master/example

我们参考官方的例子分别来写下用来对比的例子:

grace

package mainimport (  "time"  "net/http"  "github.com/facebookgo/grace/gracehttp")func main() {  gracehttp.Serve(    &http.Server{Addr: ":5001", Handler: newGraceHandler()},    &http.Server{Addr: ":5002", Handler: newGraceHandler()},  )}func newGraceHandler() http.Handler {  mux := http.NewServeMux()  mux.HandleFunc("/sleep", func(w http.ResponseWriter, r *http.Request) {    duration, err := time.ParseDuration(r.FormValue("duration"))    if err != nil {      http.Error(w, err.Error(), 400)      return    }    time.Sleep(duration)    w.Write([]byte("Hello World"))  })  return mux}

endless

package mainimport (  "log"  "net/http"  "os"  "sync"  "time"  "github.com/fvbock/endless"  "github.com/gorilla/mux")func handler(w http.ResponseWriter, r *http.Request) {  duration, err := time.ParseDuration(r.FormValue("duration"))  if err != nil {    http.Error(w, err.Error(), 400)    return  }  time.Sleep(duration)  w.Write([]byte("Hello World"))}func main() {  mux1 := mux.NewRouter()  mux1.HandleFunc("/sleep", handler)  w := sync.WaitGroup{}  w.Add(2)  go func() {    err := endless.ListenAndServe(":5003", mux1)    if err != nil {      log.Println(err)    }    log.Println("Server on 5003 stopped")    w.Done()  }()  go func() {    err := endless.ListenAndServe(":5004", mux1)    if err != nil {      log.Println(err)    }    log.Println("Server on 5004 stopped")    w.Done()  }()  w.Wait()  log.Println("All servers stopped. Exiting.")  os.Exit(0)}

overseer

package mainimport (  "fmt"  "net/http"  "time"  "github.com/jpillora/overseer")//see example.sh for the use-case// BuildID is compile-time variablevar BuildID = "0"//convert your 'main()' into a 'prog(state)'//'prog()' is run in a child processfunc prog(state overseer.State) {  fmt.Printf("app#%s (%s) listening...\n", BuildID, state.ID)  http.Handle("/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {    duration, err := time.ParseDuration(r.FormValue("duration"))    if err != nil {      http.Error(w, err.Error(), 400)      return    }    time.Sleep(duration)    w.Write([]byte("Hello World"))    fmt.Fprintf(w, "app#%s (%s) says hello\n", BuildID, state.ID)  }))  http.Serve(state.Listener, nil)  fmt.Printf("app#%s (%s) exiting...\n", BuildID, state.ID)}//then create another 'main' which runs the upgrades//'main()' is run in the initial processfunc main() {  overseer.Run(overseer.Config{    Program: prog,    Addresses: []string{":5005", ":5006"},    //Fetcher: &fetcher.File{Path: "my_app_next"},    Debug:  false, //display log of overseer actions  })}

对比

对比示例的操作步骤

  • 分别构建上面的示例,并记录pid

  • 调用API,在其未返回时,修改内容(Hello World -> Hello Harry),重新构建。查看旧API是否返回旧的内容

  • 调用新API,查看返回的内容是否是新的内容

  • 查看当前运行的pid,是否与之前一致

下面给一下操作命令

# 第一次构建项目go build grace.go# 运行项目,这时就可以做内容修改了./grace &# 请求项目,60s后返回curl "http://127.0.0.1:5001/sleep?duration=60s" &# 再次构建项目,这里是新内容go build grace.go# 重启,2096为pidkill -USR2 2096# 新API请求curl "http://127.0.0.1:5001/sleep?duration=1s"# 第一次构建项目go build endless.go# 运行项目,这时就可以做内容修改了./endless &# 请求项目,60s后返回curl "http://127.0.0.1:5003/sleep?duration=60s" &# 再次构建项目,这里是新内容go build endless.go# 重启,22072为pidkill -1 22072# 新API请求curl "http://127.0.0.1:5003/sleep?duration=1s"# 第一次构建项目go build -ldflags '-X main.BuildID=1' overseer.go# 运行项目,这时就可以做内容修改了./overseer &# 请求项目,60s后返回curl "http://127.0.0.1:5005/sleep?duration=60s" &# 再次构建项目,这里是新内容,注意版本号不同了go build -ldflags '-X main.BuildID=2' overseer.go# 重启,28300为主进程pidkill -USR2 28300# 新API请求curl http://127.0.0.1:5005/sleep?duration=1s

对比结果

示例旧API返回值新API返回值旧pid新pid结论
graceHello worldHello Harry20963100旧API不会断掉,会执行原来的逻辑,pid会变化
endlessHello worldHello Harry2207222365旧API不会断掉,会执行原来的逻辑,pid会变化
overseerHello worldHello Harry2830028300旧API不会断掉,会执行原来的逻辑,主进程pid不会变化

原理分析

可以看出grace和endless是比较像的。

  • 监听信号

  • 收到信号时fork子进程(使用相同的启动命令),将服务监听的socket文件描述符传递给子进程

  • 子进程监听父进程的socket,这个时候父进程和子进程都可以接收请求

  • 子进程启动成功之后,父进程停止接收新的连接,等待旧连接处理完成(或超时)

  • 父进程退出,升级完成

overseer是不同的,主要是overseer加了一个主进程管理平滑重启,子进程处理链接,能够保持主进程pid不变。

如下图表示的很形象

自己实现

我们下面来尝试自己实现下第一种处理,代码如下,代码来自《热重启golang服务器》:

package mainimport (  "context"  "errors"  "flag"  "log"  "net"  "net/http"  "os"  "os/exec"  "os/signal"  "syscall"  "time")var (  server  *http.Server  listener net.Listener  graceful = flag.Bool("graceful", false, "listen on fd open 3 (internal use only)"))func sleep(w http.ResponseWriter, r *http.Request) {  duration, err := time.ParseDuration(r.FormValue("duration"))  if err != nil {    http.Error(w, err.Error(), 400)    return  }  time.Sleep(duration)  w.Write([]byte("Hello World"))}func main() {  flag.Parse()  http.HandleFunc("/sleep", sleep)  server = &http.Server{Addr: ":5007"}  var err error  if *graceful {    log.Print("main: Listening to existing file descriptor 3.")    // cmd.ExtraFiles: If non-nil, entry i becomes file descriptor 3+i.    // when we put socket FD at the first entry, it will always be 3(0+3)    f := os.NewFile(3, "")    listener, err = net.FileListener(f)  } else {    log.Print("main: Listening on a new file descriptor.")    listener, err = net.Listen("tcp", server.Addr)  }  if err != nil {    log.Fatalf("listener error: %v", err)  }  go func() {    // server.Shutdown() stops Serve() immediately, thus server.Serve() should not be in main goroutine    err = server.Serve(listener)    log.Printf("server.Serve err: %v\n", err)  }()  signalHandler()  log.Printf("signal end")}func reload() error {  tl, ok := listener.(*net.TCPListener)  if !ok {    return errors.New("listener is not tcp listener")  }  f, err := tl.File()  if err != nil {    return err  }  args := []string{"-graceful"}  cmd := exec.Command(os.Args[0], args...)  cmd.Stdout = os.Stdout  cmd.Stderr = os.Stderr  // put socket FD at the first entry  cmd.ExtraFiles = []*os.File{f}  return cmd.Start()}func signalHandler() {  ch := make(chan os.Signal, 1)  signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM, syscall.SIGUSR2)  for {    sig := <-ch    log.Printf("signal: %v", sig)    // timeout context for shutdown    ctx, _ := context.WithTimeout(context.Background(), 100*time.Second)    switch sig {    case syscall.SIGINT, syscall.SIGTERM:      // stop      log.Printf("stop")      signal.Stop(ch)      server.Shutdown(ctx)      log.Printf("graceful shutdown")      return    case syscall.SIGUSR2:      // reload      log.Printf("reload")      err := reload()      if err != nil {        log.Fatalf("graceful restart error: %v", err)      }      server.Shutdown(ctx)      log.Printf("graceful reload")      return    }  }}

以上是"Golang中如何实现平滑重启"这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注行业资讯频道!

0