фон

Горутину, являющуюся основным компонентом реализации параллелизма в golang, очень легко начать, но ее сложно хорошо контролировать. Мы часто сталкиваемся с различными формами утечек горутины, и эти утечки горутины сохраняются до тех пор, пока процесс не завершится. Память стека, которую они занимают, не может быть освобождена, а связанная с ней память кучи не может быть очищена GC. Доступная память системы будет становиться все меньше и меньше по мере увеличения количества утекших горутин, пока она не выйдет из строя!

goroutine Утечки обычно сопровождаются сложным взаимодействием между сопрограммами. Проверки кода и регулярные модульные тесты обычно больше ориентированы на правильную бизнес-логику и их трудно полностью охватить. goroutine утечка сцены; pprof Инструменты анализа производительности более полезны для мониторинга сигналов тревоги/неисправностей и их анализа. Нам нужен инструмент, который сможет идентифицировать перед компиляцией и развертыванием goroutine Утечка инструментов контролирует качество проекта начиная с верхнего уровня. goleak(https://github.com/uber-go/goleak MIT Лицензионное соглашение) да Uber Проект с открытым исходным кодом от команды goroutine Инструмент обнаружения утечек, который может быть очень легким и интегрирован в тест, для goroutine Это полезно для предотвращения утечек и повышения инженерной надежности.

Профилактика лучше, чем облегчение.

Пример утечки горутины

Дай сначала один goroutine Пример утечки, как показано ниже, утечка; в методе ch Никогда не читай и никогда не закрывай, пиши ch из goroutine Он находился в заблокированном состоянии, что очень типично. goroutine утечка.

func leak() {
    ch := make(chan struct{})
    go func() {
        ch <- struct{}{}
    }()
}

Обычно мы будем использовать метод утечки, который записывается примерно так:

func TestLeak(t *testing.T) {
    leak()
}

Используйте go test, чтобы выполнить тест и просмотреть результаты:

$ go test -v -run ^TestLeak$
=== RUN   TestLeak
--- PASS: TestLeak (0.00s)
PASS
ok      cool-go.gocn.vip/goleak 0.007s

Тест прошёл без сюрпризов, идите Встроенный изтест, очевидно, не может помочь нам определить leakсерединаиз goroutine утечка.

Интегрируйте тестирование Goleak

goleak Метод воздействия особенно упрощен, обычно нам нужно только сфокусироваться на VerifyNone и VerifyTestMain Два метода, они также соответствуют goleak из Два вида Метод интеграции:

1. Интеграция по каждому сценарию использования Добавить в первую строку существующего тестиз defer goleak.VerifyNone(t), вы можете интегрировать goleak Обнаружение утечек:

func TestLeakWithGoleak(t *testing.T) {
    defer goleak.VerifyNone(t)
    leak()
}

на этот разиз go test неуспешный:

$ go test -v -run ^TestLeakWithGoleak$
=== RUN   TestLeakWithGoleak
    leaks.go:78: found unexpected goroutines:
        [Goroutine 19 in state chan send, with cool-go.gocn.vip/goleak.leak.func1 on top of the stack:
        goroutine 19 [chan send]:
        cool-go.gocn.vip/goleak.leak.func1(0xc00008c420)
                /Users/blanet/gocn/goleak/main.go:24 +0x35
        created by cool-go.gocn.vip/goleak.leak
                /Users/blanet/gocn/goleak/main.go:23 +0x4e
        ]
--- FAIL: TestLeakWithGoleak (0.45s)
FAIL
exit status 1
FAIL cool-go.gocn.vip/goleak 0.459s

Отчет об испытаниях отображается в виде leak.func1 из goroutine Произошла утечка (leak.func1 Здесь это означает изда leak в методе первый анонимный метод) и установите неудачный результат теста. Нам удалосьпроходить goleak Нашел это goroutine утечка.

1. Интеграция через TestMain Если вы чувствуете Интеграцию по каждому сценарию использования goleak из Метод слишком громоздкий или “***” Секс слишком силен, можно попробовать вообще не менять исходный пример тестиспользовать, провести в Добавить в TestMain goleak.VerifyTestMain(m) из Способинтегрированный goleak：

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

на этот разиз go test Вывод следующий:

$ go test -v -run ^TestLeak$
=== RUN   TestLeak
--- PASS: TestLeak (0.00s)
PASS
goleak: Errors on successful test run: found unexpected goroutines:
[Goroutine 19 in state chan send, with cool-go.gocn.vip/goleak.leak.func1 on top of the stack:
goroutine 19 [chan send]:
cool-go.gocn.vip/goleak.leak.func1(0xc00008c2a0)
        /Users/blanet/gocn/goleak/main.go:24 +0x35
created by cool-go.gocn.vip/goleak.leak
        /Users/blanet/gocn/goleak/main.go:23 +0x4e
]
exit status 1
FAIL    cool-go.gocn.vip/goleak 0.455s

Видно, голак Успешно обнаружено снова goroutine Утечка, но с Интеграцией по каждому сценарию В отличие от использования изда, goleak.VerifyTestMain сначала сообщает об использовании результатов выполнения дела, а затем выполняет анализ утечек. Если один тест выполняет несколько экземпляров использования и в конечном итоге происходит утечка, то TestMain Способинтегрированныйиз goleak Невозможно точно определить возникновение goroutine Случаи утечки требуют дальнейшего анализа. goleak Следующий скрипт предоставляется для дальнейшего определения конкретного события. goroutine Утечка изиспользовать кейсы, их суть заключается в выполнении всех кейсов по одному для анализа:

# 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 -E "^(Test|Example)"); do
    ./tests -test.run "^$test\$" &>/dev/null && echo -n "." || echo "\n$test failed"
done

Подвести итог

goleak Получить время выполнения из анализа стека goroutine статуса и разработал очень простой и удобный интерфейс для взаимодействия с тестовой средой, небольшой и мощный goroutine Идеальное средство предотвращения утечек. Конечно, полный пример итестиспользовать подтверждает goleak играть рольиспользоватьиз База,Все равно нужно писать честно,Стабильное производство!

Ссылки https://github.com/uber-go/goleak https://pkg.go.dev/go.uber.org/goleak https://rakyll.org/leakingctx/ https://github.com/golang/go/issues/6705 https://medium.com/golangspec/goroutine-leak-400063aef468 https://dave.cheney.net/2016/12/22/never-start-a-goroutine-without-knowing-how-it-will-stop