goleak

Goroutine 泄漏检测器。「Goroutine leak detector」

Github星跟踪图

goleak GoDoc Build Status Coverage Status

Goroutine leak detector to help avoid Goroutine leaks.

Installation

You can use go get to get the latest version:

go get -u go.uber.org/goleak

goleak also supports semver releases. It is compatible with Go 1.5+.

Quick Start

To verify that there are no unexpected goroutines running at the end of a test:

func TestA(t *testing.T) {
	defer goleak.VerifyNone(t)

	// test logic here.
}

Instead of checking for leaks at the end of every test, goleak can also be run
at the end of every test package by creating a TestMain function for your
package:

func TestMain(m *testing.M) {
	goleak.VerifyTestMain(m)
}

Determine Source of Package Leaks

When verifying leaks using TestMain, the leak test is only run once after all tests
have been run. This is typically enough to ensure there's no goroutines leaked from
tests, but when there are leaks, it's hard to determine which test is causing them.

You can use the following bash script to determine the source of the failing test:

# Create a test binary which will be used to run each test individually
$ go test -c -o tests

# Run each test individually, printing "." for successful tests, or the test name
# for failing tests.
$ for test in $(go test -list ., grep "^Test"); do ./tests -test.run "^$test\$" &>/dev/null && echo -n ".", echo "\n$test failed"; done

This will only print names of failing tests which can be investigated individually. E.g.,

.....
TestLeakyTest failed
.......

Stability

goleak is v1 and follows SemVer strictly.

No breaking changes will be made to exported APIs before 2.0.

主要指标

概览
名称与所有者uber-go/goleak
主编程语言Go
编程语言Go (语言数: 2)
平台
许可证MIT License
所有者活动
创建于2017-11-02 23:39:06
推送于2024-11-21 20:38:38
最后一次提交2024-11-21 12:38:38
发布数9
最新版本名称v1.3.0 (发布于 )
第一版名称v0.10.0 (发布于 2017-12-07 16:24:16)
用户参与
星数4.8k
关注者数45
派生数154
提交数85
已启用问题?
问题数35
打开的问题数11
拉请求数79
打开的拉请求数4
关闭的拉请求数14
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?