Golang服务平滑重启

2024-09-08 13:48
文章标签 服务 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 variable
var BuildID = "0"//convert your 'main()' into a 'prog(state)'
//'prog()' is run in a child process
func 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 process
func 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为pid
kill -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为pid
kill -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为主进程pid
kill -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是比较像的。
热重启的原理非常简单，但是涉及到一些系统调用以及父子进程之间文件句柄的传递等等细节比较多。
处理过程分为以下几个步骤：

  1. 监听信号（USR2）
  2. 收到信号时fork子进程（使用相同的启动命令），将服务监听的socket文件描述符传递给子进程
  3. 子进程监听父进程的socket，这个时候父进程和子进程都可以接收请求
  4. 子进程启动成功之后，父进程停止接收新的连接，等待旧连接处理完成（或超时）
  5. 父进程退出，升级完成

overseer是与grace和endless有些不同，主要是两点：

  1. overseer添加了Fetcher，当Fetcher返回有效的二进位流(io.Reader) 时，主进程会将它保存到临时位置并验证它，替换当前的二进制文件并启动。
    Fetcher运行在一个goroutine中，预先会配置好检查的间隔时间。Fetcher支持File、GitHub、HTTP和S3的方式。详细可查看包package fetcher
  2. overseer添加了一个主进程管理平滑重启。子进程处理连接，能够保持主进程pid不变。

如下图表示的很形象
在这里插入图片描述

细节

  • 父进程将socket文件描述符传递给子进程可以通过命令行，或者环境变量等
  • 子进程启动时使用和父进程一样的命令行，对于golang来说用更新的可执行程序覆盖旧程序
  • server.Shutdown()优雅关闭方法是go1.8的新特性
  • server.Serve(l)方法在Shutdown时立即返回，Shutdown方法则阻塞至context完成，所以Shutdown的方法要写在主goroutine中

代码

package mainimport ("context""errors""flag""log""net""net/http""os""os/exec""os/signal""syscall""time"
)var (server   *http.Serverlistener net.Listenergraceful = flag.Bool("graceful", false, "listen on fd open 3 (internal use only)")
)func handler(w http.ResponseWriter, r *http.Request) {time.Sleep(20 * time.Second)w.Write([]byte("hello world233333!!!!"))
}func main() {flag.Parse()http.HandleFunc("/hello", handler)server = &http.Server{Addr: ":9999"}var err errorif *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 goroutineerr = 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.Stdoutcmd.Stderr = os.Stderr// put socket FD at the first entrycmd.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 := <-chlog.Printf("signal: %v", sig)// timeout context for shutdownctx, _ := context.WithTimeout(context.Background(), 20*time.Second)switch sig {case syscall.SIGINT, syscall.SIGTERM:// stoplog.Printf("stop")signal.Stop(ch)server.Shutdown(ctx)log.Printf("graceful shutdown")returncase syscall.SIGUSR2:// reloadlog.Printf("reload")err := reload()if err != nil {log.Fatalf("graceful restart error: %v", err)}server.Shutdown(ctx)log.Printf("graceful reload")return}}
}

代码可参考：https://github.com/CraryPrimitiveMan/go-in-action/tree/master/ch4

systemd & supervisor

父进程退出之后，子进程会挂到1号进程上面。这种情况下使用systemd和supervisord等管理程序会显示进程处于failed的状态。解决这个问题有两个方法：

  • 使用pidfile，每次进程重启更新一下pidfile，让进程管理者通过这个文件感知到mainpid的变更。
  • 起一个master来管理服务进程，每次热重启master拉起一个新的进程，把旧的kill掉。这时master的pid没有变化，对于进程管理者来说进程处于正常的状态。一个简洁的实现

这篇关于Golang服务平滑重启的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1148277。

相关文章

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

《Android悬浮窗开发示例((动态权限请求|前台服务和通知|悬浮窗创建)》本文介绍了Android悬浮窗的实现效果,包括动态权限请求、前台服务和通知的使用,悬浮窗权限需要动态申请并引导... 目录一、悬浮窗 动态权限请求1、动态请求权限2、悬浮窗权限说明3、检查动态权限4、申请动态权限5、权限设置完毕后
阅读更多...
golang内存对齐的项目实践

golang内存对齐的项目实践

《golang内存对齐的项目实践》本文主要介绍了golang内存对齐的项目实践,内存对齐不仅有助于提高内存访问效率,还确保了与硬件接口的兼容性,是Go语言编程中不可忽视的重要优化手段,下面就来介绍一下... 目录一、结构体中的字段顺序与内存对齐二、内存对齐的原理与规则三、调整结构体字段顺序优化内存对齐四、内
阅读更多...
TP-Link PDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务

TP-Link PDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务

《TP-LinkPDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务》近期，路由器制造巨头普联（TP-Link）在用户群体中引发了一系列重要变动,上个月，公司发出了一则通知，明确要求所... 路由器厂商普联（TP-Link）上个月发布公告要求所有用户必须完成实名认证后才能继续使用普联提供的 D
阅读更多...
微服务架构之使用RabbitMQ进行异步处理方式

微服务架构之使用RabbitMQ进行异步处理方式

《微服务架构之使用RabbitMQ进行异步处理方式》本文介绍了RabbitMQ的基本概念、异步调用处理逻辑、RabbitMQ的基本使用方法以及在SpringBoot项目中使用RabbitMQ解决高并发... 目录一.什么是RabbitMQ？二.异步调用处理逻辑：三.RabbitMQ的基本使用1.安装2.架构
阅读更多...
Java中使用Java Mail实现邮件服务功能示例

Java中使用Java Mail实现邮件服务功能示例

《Java中使用JavaMail实现邮件服务功能示例》：本文主要介绍Java中使用JavaMail实现邮件服务功能的相关资料,文章还提供了一个发送邮件的示例代码,包括创建参数类、邮件类和执行结... 目录前言一、历史背景二编程、pom依赖三、API说明（一）Session （会话）（二）Message编程客
阅读更多...
windos server2022的配置故障转移服务的图文教程

windos server2022的配置故障转移服务的图文教程

《windosserver2022的配置故障转移服务的图文教程》本文主要介绍了windosserver2022的配置故障转移服务的图文教程,以确保服务和应用程序的连续性和可用性,文中通过图文介绍的非... 目录准备环境：步骤故障转移群集是 Windows Server 2022 中提供的一种功能，用于在多个
阅读更多...
Golang操作DuckDB实战案例分享

Golang操作DuckDB实战案例分享

《Golang操作DuckDB实战案例分享》DuckDB是一个嵌入式SQL数据库引擎,它与众所周知的SQLite非常相似,但它是为olap风格的工作负载设计的,DuckDB支持各种数据类型和SQL特性... 目录DuckDB的主要优点环境准备初始化表和数据查询单行或多行错误处理和事务完整代码最后总结Duck
阅读更多...
Golang的CSP模型简介(最新推荐)

Golang的CSP模型简介(最新推荐)

《Golang的CSP模型简介(最新推荐)》Golang采用了CSP（CommunicatingSequentialProcesses,通信顺序进程）并发模型,通过goroutine和channe... 目录前言一、介绍1. 什么是 CSP 模型2. Goroutine3. Channel4. Channe
阅读更多...
解决systemctl reload nginx重启Nginx服务报错:Job for nginx.service invalid问题

解决systemctl reload nginx重启Nginx服务报错:Job for nginx.service invalid问题

《解决systemctlreloadnginx重启Nginx服务报错:Jobfornginx.serviceinvalid问题》文章描述了通过`systemctlstatusnginx.se... 目录systemctl reload nginx重启Nginx服务报错:Job for nginx.javas
阅读更多...
windows系统下shutdown重启关机命令超详细教程

windows系统下shutdown重启关机命令超详细教程

《windows系统下shutdown重启关机命令超详细教程》shutdown命令是一个强大的工具,允许你通过命令行快速完成关机、重启或注销操作,本文将为你详细解析shutdown命令的使用方法,并提... 目录一、shutdown 命令简介二、shutdown 命令的基本用法三、远程关机与重启四、实际应用
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2