-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore][cmd/configschema] Enable goleak (#30492)
**Description:** A lot of leaks were happening in this package because of the extensive list of indirect dependencies. I've filed issues and referenced them for each indirect leak. This PR contains two main changes: 1. Enable `goleak` checks for all tests within `cmd/configschema`. 2. k8s.io/klog v1 has a leaking goroutine that was [resolved in v2](kubernetes/klog#188). I upgraded the dependency in `recevier/awscontainerinsights` to resolve this issue. This is a code change, but is totally internal and no user impact. **Link to tracking Issue:** <Issue number if applicable> #30438 **Testing:** goleak test is passing **Thoughts** 1. Some of these indirect dependencies may never get fixed. For example, one source of a leaking goroutine is [cihub/seelog](https://github.com/cihub/seelog), which hasn't had a commit in 8 years. 2. Indirect dependencies that start goroutines in `init()` are the most common cause. For an example of how indirect it gets, we can look at the dbus leak. ``` crobert$ ~/dev/opentelemetry-collector-contrib/cmd/configschema $ go mod why github.com/godbus/dbus # github.com/godbus/dbus github.com/open-telemetry/opentelemetry-collector-contrib/cmd/configschema/cfgmetadatagen github.com/open-telemetry/opentelemetry-collector-contrib/internal/components github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver github.com/snowflakedb/gosnowflake github.com/99designs/keyring github.com/godbus/dbus ``` The bug is in the `99designs/keyring` dependency, and the `goleak` is detected as far back as `cmd/configschema` tests.
- Loading branch information
Showing
10 changed files
with
33 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package configschema | ||
|
||
import ( | ||
"testing" | ||
|
||
"go.uber.org/goleak" | ||
) | ||
|
||
// The Ignore function calls prevent catching leaks generated by indirect dependencies. | ||
// All of these are leaks that we can't fix from within the collector code base. | ||
// Regarding the OpenCensus ignore: see https://github.com/census-instrumentation/opencensus-go/issues/1191 | ||
// Regarding the DataDog ignore: see https://github.com/DataDog/datadog-agent/issues/22030 | ||
// Regarding the database/sql ignore: see https://github.com/SAP/go-hdb/issues/130 | ||
// Regarding the SAP/go-hdb ignore: see https://github.com/SAP/go-hdb/issues/131 | ||
// Regarding the cihub/seelog ignore: see https://github.com/cihub/seelog/issues/182 | ||
// Regarding the godbus/dbus ignore: see https://github.com/99designs/keyring/issues/135 | ||
func TestMain(m *testing.M) { | ||
goleak.VerifyTestMain(m, | ||
goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"), | ||
goleak.IgnoreTopFunction("github.com/DataDog/datadog-agent/pkg/trace/metrics/timing.(*Set).Autoreport.func1"), | ||
// Unfortunately this ignore can't be anymore specific, even though it's caused by the SAP/go-hdb/driver | ||
// package. There's no reference to this package in the goleak output. This has the potential of | ||
// hiding future leaks, so we should remove as soon as the referenced issue is resolved. | ||
goleak.IgnoreTopFunction("database/sql.(*DB).connectionOpener"), | ||
goleak.IgnoreTopFunction("github.com/SAP/go-hdb/driver.(*metrics).collect"), | ||
goleak.IgnoreAnyFunction("github.com/cihub/seelog.(*asyncLoopLogger).processQueue"), | ||
goleak.IgnoreAnyFunction("github.com/godbus/dbus.(*Conn).inWorker")) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters