正文
划重点
本文将从什么是 goroutine leak，如何检测以及常用的分析工具来介绍 PouchContainer 在 goroutine leak 方面的检测实践。本文作者聿歌。
0. 引言
PouchContainer 是阿里巴巴集团开源的一款容器运行时产品，它具备强隔离和可移植性等特点，可用来帮助企业快速实现存量业务容器化，以及提高企业内部物理资源的利用率。
PouchContainer 同时还是一款 golang 项目。在此项目中，大量运用了 goroutine 来实现容器管理、镜像管理和日志管理等模块。goroutine 是 golang 在语言层面就支持的用户态 “线程”，这种原生支持并发的特性能够帮助开发者快速构建高并发的服务。
虽然 goroutine 容易完成并发或者并行的操作，但如果出现 channel 接收端长时间阻塞却无法唤醒的状态，那么将会出现
goroutine leak
。 goroutine leak 同内存泄漏一样可怕，这样的 goroutine 会不断地吞噬资源，导致系统运行变慢，甚至是崩溃。为了让系统能健康运转，需要开发者保证 goroutine 不会出现泄漏的情况。 接下来本文将从什么是 goroutine leak, 如何检测以及常用的分析工具来介绍
PouchContainer 在 goroutine leak 方面的检测实践。
1. Goroutine Leak
在 golang 的世界里，你能支配的土拨鼠有很多，它们既可以同时处理一大波同样的问题，也可以协作处理同一件事，只要你指挥得当，问题就能很快地处理完毕。没错，土拨鼠就是我们常说的
goroutine
，你只要轻松地
go
一下，你就拥有了一只土拨鼠，它便会执行你所指定的任务：
func main() { waitCh := make(chan struct{}) go func() { fmt.Println("Hi, Pouch. I'm new gopher!") waitCh <- struct{}{} }() <-waitCh}
正常情况下，一只土拨鼠完成任务之后，它将会回笼，然后等待你的下一次召唤。但是也有可能出现这只土拨鼠很长时间没有回笼的情况。
func main() { // /exec?cmd=xx&args=yy runs the shell command in the host http.HandleFunc("/exec", func(w http.ResponseWriter, r *http.Request) { defer func() { log.Printf("finish %v\n", r.URL) }() out, err := genCmd(r).CombinedOutput() if err != nil { w.WriteHeader(500) w.Write([]byte(err.Error())) return } w.Write(out) }) log.Fatal(http.ListenAndServe(":8080", nil))}func genCmd(r *http.Request) (cmd *exec.Cmd) { var args []string if got := r.FormValue("args"); got != "" { args = strings.Split(got, " ") } if c := r.FormValue("cmd"); len(args) == 0 { cmd = exec.Command(c) } else { cmd = exec.Command(c, args...) } return}
上面这段代码会启动 HTTP Server，它将允许客户端通过 HTTP 请求的方式来远程执行 shell 命令，比如可以使用
curl "{ip}:8080/exec?cmd=ps&args=-ef"
来查看 Server 端的进程情况。执行完毕之后，土拨鼠会打印日志，并说明该指令已执行完毕。
但是有些时候，请求需要土拨鼠花很长的时间处理，而请求者却没有等待的耐心，比如
curl -m 3 "{ip}:8080/exec?cmd=dosomething"
，即在 3 秒内执行完某一条命令，不然请求者将会断开链接。由于上述代码并没有检测链接断开的功能，如果请求者不耐心等待命令完成而是中途断开链接，那么这个土拨鼠也只有在执行完毕后才会回笼。可怕的是，遇到这种
curl -m 1 "{ip}:8080/exec?cmd=sleep&args=10000"
，没法及时回笼的土拨鼠会占用系统的资源。
这些流离在外、不受控制的土拨鼠，就是我们常说的
goroutine leak
。造成 goroutine leak 的原因有很多，比如 channel 没有发送者。运行下面的代码之后，你会发现 runtime 会稳定地显示目前共有 2 个 goroutine，其中一个是
main
函数自己，另外一个就是一直在等待数据的土拨鼠。
func main() { logGoNum() // without sender and blocking.... var ch chan int go func(ch chan int) { <-ch }(ch) for range time.Tick(2 * time.Second) { logGoNum() }}func logGoNum() { log.Printf("goroutine number: %d\n", runtime.NumGoroutine())}
造成 goroutine leak 有很多种不同的场景，本文接下来会通过描述 Pouch Logs API 场景，介绍如何对 goroutine leak 进行检测并给出相应的解决方案。
2. Pouch Logs API 实践
2.1 具体场景
为了更好地说明问题，本文将 Pouch Logs HTTP Handler 的代码进行简化：
func logsContainer(ctx context.Context, w http.ResponseWriter, r *http.Request) { ... writeLogStream(ctx, w, msgCh) return}func writeLogStream(ctx context.Context, w http.ResponseWriter, msgCh <-chan Message) { for { select { case <-ctx.Done(): return case msg, ok := <-msgCh: if !ok { return } w.Write(msg.Byte()) } }}
Logs API Handler 会启动 goroutine 去读取日志，并通过 channel 的方式将数据传递给
writeLogStream
，
writeLogStream
便会将数据返回给调用者。这个 Logs API 具有
跟随
功能，它将会持续地显示新的日志内容，直到容器停止。但是对于调用者而言，它随时都会终止请求。那么我们怎么检测是否存在遗留的
goroutine 呢？
当链接断开之后，Handler 还想给 Client 发送数据，那么将会出现 write: broken pipe 的错误，通常情况下 goroutine 会退出。但是如果 Handler 还在长时间等待数据的话，那么就是一次 goroutine leak 事件。
2.2 如何检测 goroutine leak？
对于 HTTP Server 而言，我们通常会通过引入包
net/http/pprof
来查看当前进程运行的状态，其中有一项就是查看 goroutine stack 的信息，
{ip}:{port}/debug/pprof/goroutine?debug=2
。我们来看看调用者主动断开链接之后的 goroutine stack 信息。
# step 1: create background jobpouch run -d busybox sh -c "while true; do sleep 1; done"# step 2: follow the log and stop it after 3 secondscurl -m 3 {ip}:{port}/v1.24/containers/{container_id}/logs?stdout=1&follow=1# step 3: after 3 seconds, dump the stack infocurl -s "{ip}:{port}/debug/pprof/goroutine?debug=2" | grep -A 10 logsContainergithub.com/alibaba/pouch/apis/server.(*Server).logsContainer(0xc420330b80, 0x251b3e0, 0xc420d93240, 0x251a1e0, 0xc420432c40, 0xc4203f7a00, 0x3, 0x3) /tmp/pouchbuild/src/github.com/alibaba/pouch/apis/server/container_bridge.go:339 +0x347github.com/alibaba/pouch/apis/server.(*Server).(github.com/alibaba/pouch/apis/server.logsContainer)-fm(0x251b3e0, 0xc420d93240, 0x251a1e0, 0xc420432c40, 0xc4203f7a00, 0x3, 0x3) /tmp/pouchbuild/src/github.com/alibaba/pouch/apis/server/router.go:53 +0x5cgithub.com/alibaba/pouch/apis/server.withCancelHandler.func1(0x251b3e0, 0xc420d93240, 0x251a1e0, 0xc420432c40, 0xc4203f7a00, 0xc4203f7a00, 0xc42091dad0) /tmp/pouchbuild/src/github.com/alibaba/pouch/apis/server/router.go:114 +0x57github.com/alibaba/pouch/apis/server.filter.func1(0x251a1e0, 0xc420432c40, 0xc4203f7a00) /tmp/pouchbuild/src/github.com/alibaba/pouch/apis/server/router.go:181 +0x327net/http.HandlerFunc.ServeHTTP(0xc420a84090, 0x251a1e0, 0xc420432c40, 0xc4203f7a00) /usr/local/go/src/net/http/server.go:1918 +0x44github.com/alibaba/pouch/vendor/github.com/gorilla/mux.(*Router).ServeHTTP(0xc4209fad20, 0x251a1e0, 0xc420432c40, 0xc4203f7a00) /tmp/pouchbuild/src/github.com/alibaba/pouch/vendor/github.com/gorilla/mux/mux.go:133 +0xednet/http.serverHandler.ServeHTTP(0xc420a18d00, 0x251a1e0, 0xc420432c40, 0xc4203f7800)
我们会发现当前进程中还存留着
logsContainer
goroutine。因为这个容器没有输出任何日志的机会，所以这个 goroutine 没办法通过
write: broken pipe
的错误退出，它会一直占用着系统资源。那我们该怎么解决这个问题呢？
2.3 怎么解决？
golang 提供的包
net/http
有监控链接断开的功能:
// HTTP Handler Interceptorsfunc withCancelHandler(h handler) handler { return func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error { // https://golang.org/pkg/net/http/#CloseNotifier if notifier, ok := rw.(http.CloseNotifier); ok { var cancel context.CancelFunc ctx, cancel = context.WithCancel(ctx) waitCh := make(chan struct{}) defer close(waitCh) closeNotify := notifier.CloseNotify() go func() { select { case <-closeNotify: cancel() case <-waitCh: } }() } return h(ctx, rw, req) }}
当请求还没执行完毕时，客户端主动退出了，那么
CloseNotify()
将会收到相应的消息，并通过
context.Context
来取消，这样我们就可以很好地处理 goroutine leak 的问题了。在 golang 的世界里，你会经常看到
读
_ 和 _
写
的 goroutine，它们这种函数的第一个参数一般会带有
context.Context
,
这样就可以通过
WithTimeout
和
WithCancel
来控制 goroutine 的回收，避免出现泄漏的情况。
