[chore][cmd/configschema] Enable goleak #30492
Merged
Conversation
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
github-actions
bot
added
cmd/configschema
crobert-1
changed the title
|
If it's helpful, I can split out the klog v1 to v2 upgrade to a different PR, just let me know. |
mx-psi
approved these changes
Jan 15, 2024
There was a problem hiding this comment.
Personally I am fine with keeping the klog change here if we get an approval from @Aneurysm9 or @pxaws before merging :)
crobert-1
force-pushed
the
goleak_configschema
branch
from
755696a
to
3e1ea0b
Compare
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
Should we remove the |
- Ignore datadog leaking goroutine, opened issue - Upgrade k8s.io/klog dependency to v2 to avoid leaking goroutine. Relevant link: kubernetes/klog#188
crobert-1
force-pushed
the
goleak_configschema
branch
from
6ab1282
to
1803cf6
Compare
I believe we still need it, as the leak is coming from the opentelemetry-collector-contrib/go.mod Lines 704 to 705 in f69e977 |
|
Okay, let's wait a week more for @Aneurysm9 or @Pwasx to chime in, if not I can merge this |
dmitryax
approved these changes
Mar 6, 2024
DougManton
pushed a commit
to DougManton/opentelemetry-collector-contrib
that referenced
this pull request
Mar 13, 2024
**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> open-telemetry#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.
XinRanZhAWS
pushed a commit
to XinRanZhAWS/opentelemetry-collector-contrib
that referenced
this pull request
Mar 13, 2024
**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> open-telemetry#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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
goleakchecks for all tests withincmd/configschema.recevier/awscontainerinsightsto resolve this issue. This is a code change, but is totally internal and no user impact.Link to tracking Issue:
#30438
Testing:
goleak test is passing
Thoughts
init()are the most common cause. For an example of how indirect it gets, we can look at the dbus leak.The bug is in the
99designs/keyringdependency, and thegoleakis detected as far back ascmd/configschematests.