Go:协程泄漏探测器

【译文】原文地址


使用APM监控goroutine的数量,可以容易的发现goroutine泄漏。下图是来自NewRelic(APM工具开发商)的一张监控goroutines的图片。

协程泄漏会导致协程数量持续增长直到服务器奔溃。然而,有很多方法来避免泄漏即使在代码部署之前也可以。

探测泄漏

Uber的Go团队在Github上面是一个很活跃的团队,开发了一个Goroutine泄漏探测器,是一个用于和单元测试集成的工具。这个包实际上是监测单元测试代码运行时协程的泄漏。以下是一个函数存在goroutine泄漏:

func leak() error {
    go func() {
        time.Sleep(time.Minute)
    }()
    return nil
}

下面的代码是该函数的测试代码:

func TestLeakFunction(t *testing.T)  {
    defer goleak.VerifyNone(t)
    if err := leak(); err != nil{
        t.Fatal("error not expected")
    }
}

运行测试代码会发现协程泄漏:

=== RUN   TestLeakFunction
    leaks.go:78: found unexpected goroutines:
        [Goroutine 19 in state sleep, with time.Sleep on top of the stack:
        goroutine 19 [sleep]:

上面的错误提示了两个错误信息:

  • 泄漏协程栈顶,状态信息。这个信息有助于快速发现是哪个协程泄漏。
  • 泄漏协程的ID,有助于跟踪器来可视化协程。可以使用go test ./... -trace trace.out



    从跟踪的信息,可以查看goroutine的详细执行信息。

泄漏的携程被监测到后,而且还有关于泄漏的信息。现在我们明白它是如何工作的,因此需注意这个监测的缺陷。

内部

要能监测泄露,唯一的要求就是在测试代码最后面调用该库来检查泄漏的携程即可。实际上,它会监测所有goroutine而不仅仅是泄漏的goroutine。

首先检测器列出所有创建的goroutine。以下就是上面的列子所有goroutine列表:



Goroutine的栈信息来源于导出函数runtime.Stack(go标准库函数)。因此,任何人都可以拿到这些信息。

然后,从这个协程列表中,泄漏检测器就可以通过对这些信息进行分析,然后将属于标准库的协程删除。如下:

  • test包创建的goroutine用来运行测试用例的-前面例子中第二个goroutine。
  • runtime创建的goroutine,比如接收信号的协程。
  • 当前协程-上面例子中的第一个协程。
    最后,一旦过滤掉所有正常的协程,如果没有剩余的其他协程,意味着不存在协程泄漏。但我们发现这里面存在一些限制:
  • 第三方库或内部协程启动的后台goroutine,并没有很好的处理,可能会产生错误的报告。
  • 如果其他的测试用例中没有使用泄漏检测。如果再次运行,协程还存在就会被监测到,将会误报。

这个工具不是完美的,但是了解其中的可能性和限制有助于通过测试来检测泄漏,避免对已经部署到生产环境中的代码进行调试。

有趣的是这个方法被广泛用在了net/http包来检测泄漏协程。如下是一个例子:



再次看到,内部函数afterTest查看goroutine栈来检测存在的泄漏。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,744评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,505评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,105评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,242评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,269评论 6 389
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,215评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,096评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,939评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,354评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,573评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,745评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,448评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,048评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,683评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,838评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,776评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,652评论 2 354

推荐阅读更多精彩内容

  • 背景 周所周知,内存泄漏是一个很严重的问题,会导致系统运行占用资源越来越多,无法释放,直至崩溃。所幸 Go 语言是...
    DarkCoder阅读 6,736评论 0 4
  • 在我们谈论协程(Goroutines)泄漏之前,我们先看看并发编程的概念。并发编程处理程序的并发执行。多个连续流任...
    范彬2017阅读 6,328评论 0 7
  • G (goroutine) G是goroutine的头文字, goroutine可以解释为受管理的轻量线程, go...
    雪上霜阅读 1,199评论 0 1
  • Golang因为有着比线程更加轻量级的协程的出现,使得并发编程的上手难度一下子变得亲民起来。而channel的引入...
    侯童鞋阅读 246评论 0 0
  • 目录 统一规范篇 命名篇 开发篇 优化篇 统一规范篇 本篇主要描述了公司内部同事都必须遵守的一些开发规矩,如统一开...
    零一间阅读 1,922评论 0 2