goleak

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

  • Owner: uber-go/goleak
  • Platform: Windows,Linux,Mac
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

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.

Main metrics

Overview
Name With Owneruber-go/goleak
Primary LanguageGo
Program languageGo (Language Count: 2)
Platform
License:MIT License
所有者活动
Created At2017-11-02 23:39:06
Pushed At2024-10-01 03:33:56
Last Commit At2024-09-30 20:33:56
Release Count9
Last Release Namev1.3.0 (Posted on )
First Release Namev0.10.0 (Posted on 2017-12-07 16:24:16)
用户参与
Stargazers Count4.5k
Watchers Count45
Fork Count151
Commits Count84
Has Issues Enabled
Issues Count33
Issue Open Count9
Pull Requests Count78
Pull Requests Open Count4
Pull Requests Close Count14
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private