[cmd/opampsupervisor] Fix memory leak and enable goleak #30496
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
requested review from
atoulme,
evan-bradley and
tigrannajaryan
crobert-1
changed the title
crobert-1
force-pushed
the
goleak_opampsupervisor
branch
from
778e4b0
to
ea4653e
Compare
crobert-1
changed the title
evan-bradley
approved these changes
Jan 29, 2024
|
Thanks for your patience with the review. Could you rebase on main? |
crobert-1
force-pushed
the
goleak_opampsupervisor
branch
from
4907df7
to
f676598
Compare
Done 👍 |
cparkins
pushed a commit
to AmadeusITGroup/opentelemetry-collector-contrib
that referenced
this pull request
Feb 1, 2024
…ry#30496) **Description:** <Describe what has changed.> <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> `NewSupervisor` starts two goroutines, one for the health check ticker and another running the agent process. Each was causing a leak. To resolve the health check ticker goroutine leak a `Stop` call has been added to it during shutdown. To resolve the agent process leak a wait group has been added (to make sure shutdown blocks until the agent process is completely shutdown), and a `break` statement has been changed to `return`. The `break` statement was only breaking out of the `select` statement, but since it's nested within a `for` loop, the loop just kept going instead of completing successfully. This also enables `goleak` checks for `cmd/opampsupervisor` and `cmd/opampsupervisor/supervisor` packages **Link to tracking Issue:** <Issue number if applicable> open-telemetry#30438 **Testing:** <Describe what testing was performed and which tests were added.> Existing tests and new `goleak` checks are passing.
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:
NewSupervisorstarts two goroutines, one for the health check ticker and another running the agent process. Each was causing a leak. To resolve the health check ticker goroutine leak aStopcall has been added to it during shutdown. To resolve the agent process leak a wait group has been added (to make sure shutdown blocks until the agent process is completely shutdown), and abreakstatement has been changed toreturn. Thebreakstatement was only breaking out of theselectstatement, but since it's nested within aforloop, the loop just kept going instead of completing successfully.This also enables
goleakchecks forcmd/opampsupervisorandcmd/opampsupervisor/supervisorpackagesLink to tracking Issue:
#30438
Testing:
Existing tests and new
goleakchecks are passing.