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

相关文章

【区块链 + 人才服务】可信教育区块链治理系统 | FISCO BCOS应用案例

伴随着区块链技术的不断完善,其在教育信息化中的应用也在持续发展。利用区块链数据共识、不可篡改的特性, 将与教育相关的数据要素在区块链上进行存证确权,在确保数据可信的前提下,促进教育的公平、透明、开放,为教育教学质量提升赋能,实现教育数据的安全共享、高等教育体系的智慧治理。 可信教育区块链治理系统的顶层治理架构由教育部、高校、企业、学生等多方角色共同参与建设、维护,支撑教育资源共享、教学质量评估、

【区块链 + 人才服务】区块链集成开发平台 | FISCO BCOS应用案例

随着区块链技术的快速发展,越来越多的企业开始将其应用于实际业务中。然而,区块链技术的专业性使得其集成开发成为一项挑战。针对此,广东中创智慧科技有限公司基于国产开源联盟链 FISCO BCOS 推出了区块链集成开发平台。该平台基于区块链技术,提供一套全面的区块链开发工具和开发环境,支持开发者快速开发和部署区块链应用。此外,该平台还可以提供一套全面的区块链开发教程和文档,帮助开发者快速上手区块链开发。

基于SpringBoot的宠物服务系统+uniapp小程序+LW参考示例

系列文章目录 1.基于SSM的洗衣房管理系统+原生微信小程序+LW参考示例 2.基于SpringBoot的宠物摄影网站管理系统+LW参考示例 3.基于SpringBoot+Vue的企业人事管理系统+LW参考示例 4.基于SSM的高校实验室管理系统+LW参考示例 5.基于SpringBoot的二手数码回收系统+原生微信小程序+LW参考示例 6.基于SSM的民宿预订管理系统+LW参考示例 7.基于

Golang进程权限调度包runtime

关于 runtime 包几个方法: Gosched:让当前线程让出 cpu 以让其它线程运行,它不会挂起当前线程,因此当前线程未来会继续执行GOMAXPROCS:设置最大的可同时使用的 CPU 核数Goexit:退出当前 goroutine(但是defer语句会照常执行)NumGoroutine:返回正在执行和排队的任务总数GOOS:目标操作系统NumCPU:返回当前系统的 CPU 核数量 p

Golang 网络爬虫框架gocolly/colly(五)

gcocolly+goquery可以非常好地抓取HTML页面中的数据,但碰到页面是由Javascript动态生成时,用goquery就显得捉襟见肘了。解决方法有很多种: 一,最笨拙但有效的方法是字符串处理,go语言string底层对应字节数组,复制任何长度的字符串的开销都很低廉,搜索性能比较高; 二,利用正则表达式,要提取的数据往往有明显的特征,所以正则表达式写起来比较简单,不必非常严谨; 三,使

Golang网络爬虫框架gocolly/colly(四)

爬虫靠演技,表演得越像浏览器,抓取数据越容易,这是我多年爬虫经验的感悟。回顾下个人的爬虫经历,共分三个阶段:第一阶段,09年左右开始接触爬虫,那时由于项目需要,要访问各大国际社交网站,Facebook,myspace,filcker,youtube等等,国际上叫得上名字的社交网站都爬过,大部分网站提供restful api,有些功能没有api,就只能用http抓包工具分析协议,自己爬;国内的优酷、

Golang网络爬虫框架gocolly/colly(三)

熟悉了《Golang 网络爬虫框架gocolly/colly 一》和《Golang 网络爬虫框架gocolly/colly 二》之后就可以在网络上爬取大部分数据了。本文接下来将爬取中证指数有限公司提供的行业市盈率。(http://www.csindex.com.cn/zh-CN/downloads/industry-price-earnings-ratio) 定义数据结构体: type Zhj

Golang支持平滑升级的HTTP服务

前段时间用Golang在做一个HTTP的接口,因编译型语言的特性,修改了代码需要重新编译可执行文件,关闭正在运行的老程序,并启动新程序。对于访问量较大的面向用户的产品,关闭、重启的过程中势必会出现无法访问的情况,从而影响用户体验。 使用Golang的系统包开发HTTP服务,是无法支持平滑升级(优雅重启)的,本文将探讨如何解决该问题。 一、平滑升级(优雅重启)的一般思路 一般情况下,要实现平滑

Flink任务重启策略

概述 Flink支持不同的重启策略,以在故障发生时控制作业如何重启集群在启动时会伴随一个默认的重启策略,在没有定义具体重启策略时会使用该默认策略。如果在工作提交时指定了一个重启策略,该策略会覆盖集群的默认策略默认的重启策略可以通过 Flink 的配置文件 flink-conf.yaml 指定。配置参数 restart-strategy 定义了哪个策略被使用。常用的重启策略: 固定间隔 (Fixe

Golang test编译使用

创建文件my_test.go package testsimport "testing"func TestMy(t *testing.T) {t.Log("TestMy")} 通常用法: $ go test -v -run TestMy my_test.go=== RUN TestMyTestMy: my_test.go:6: TestMy--- PASS: TestMy (0.