fix: add locking around broker throttle timer to prevent race condition #2826
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
puellanivis
reviewed
Mar 6, 2024
broker.go
Outdated
Comment on lines
1703
to
1710
| func (b *Broker) setThrottle(throttleTime time.Duration) { | ||
| if b.throttleTimer != nil { | ||
| value := b.throttleTimer.Load() | ||
| if value != nil && value != emptyTimer { | ||
| throttleTimer := value.(*time.Timer) | ||
| // if there is an existing timer stop/clear it | ||
| if !b.throttleTimer.Stop() { | ||
| <-b.throttleTimer.C | ||
| if !throttleTimer.Stop() { | ||
| <-throttleTimer.C | ||
| } | ||
| } | ||
| b.throttleTimer = time.NewTimer(throttleTime) | ||
| b.throttleTimer.CompareAndSwap(value, time.NewTimer(throttleTime)) | ||
| } |
There was a problem hiding this comment.
I’m unsure about this approach. Since this is now an atomic operation, and there is a potentially blocking operation in it, we could easily end up with two setThrottle operations running at the same time.
Of particular note is the message on the timer.Stop godoc:
This cannot be done concurrent to other receives from the Timer's channel or other calls to the Timer's Stop method.
I think we need to be handling this within a properly locked mutex.
There was a problem hiding this comment.
you are right. throttleTimer.Stop is not safe there. i change to locked mutex
chengsha
force-pushed
the
chengsha/fix-data-race-when-throttled
branch
2 times, most recently
from
c6d9d39
to
cc3fa66
Compare
…throttleTimer, which may result in a panic. add throttleTimerLock to protect Fixes IBM#2823 Signed-off-by: shacheng <shacheng@tencent.com>
chengsha
force-pushed
the
chengsha/fix-data-race-when-throttled
branch
from
cc3fa66
to
7d6b70b
Compare
dnwe
changed the title
dnwe
approved these changes
Mar 8, 2024
mx-psi
pushed a commit
to open-telemetry/opentelemetry-collector-contrib
that referenced
this pull request
Apr 2, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/IBM/sarama](https://togithub.com/IBM/sarama) | `v1.43.0` -> `v1.43.1` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>IBM/sarama (github.com/IBM/sarama)</summary> ### [`v1.43.1`](https://togithub.com/IBM/sarama/releases/tag/v1.43.1): Version 1.43.1 (2024-03-27) [Compare Source](https://togithub.com/IBM/sarama/compare/v1.43.0...v1.43.1) <!-- Release notes generated using configuration in .github/release.yaml at main --> #### What's Changed ##### 🐛 Fixes - fix: message.max.bytes should default to [`1048576`](https://togithub.com/IBM/sarama/commit/1048576) not 1 MB by [@​puellanivis](https://togithub.com/puellanivis) in [IBM/sarama#2804 - fix: add locking around broker throttle timer to prevent race condition by [@​chengsha](https://togithub.com/chengsha) in [IBM/sarama#2826 ##### 📦 Dependency updates - chore(deps): bump go.opentelemetry.io/otel/sdk from 1.23.1 to 1.24.0 in /examples/interceptors by [@​dependabot](https://togithub.com/dependabot) in [IBM/sarama#2816 - chore(deps): bump the golang-org-x group with 1 update by [@​dependabot](https://togithub.com/dependabot) in [IBM/sarama#2825 - chore(deps): bump github.com/stretchr/testify from 1.8.4 to 1.9.0 by [@​dependabot](https://togithub.com/dependabot) in [IBM/sarama#2822 - chore(deps): bump go.opentelemetry.io/otel/exporters/stdout/stdoutmetric from 1.23.1 to 1.24.0 in /examples/interceptors by [@​dependabot](https://togithub.com/dependabot) in [IBM/sarama#2815 #### New Contributors - [@​chengsha](https://togithub.com/chengsha) made their first contribution in [IBM/sarama#2826 **Full Changelog**: IBM/sarama@v1.43.0...v1.43.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
ycombinator
pushed a commit
to ycombinator/opentelemetry-collector-contrib
that referenced
this pull request
Apr 9, 2024
](https://renovatebot.com){kind=link}
…etry#32091) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/IBM/sarama](https://togithub.com/IBM/sarama) | `v1.43.0` -> `v1.43.1` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>IBM/sarama (github.com/IBM/sarama)</summary> ### [`v1.43.1`](https://togithub.com/IBM/sarama/releases/tag/v1.43.1): Version 1.43.1 (2024-03-27) [Compare Source](https://togithub.com/IBM/sarama/compare/v1.43.0...v1.43.1) <!-- Release notes generated using configuration in .github/release.yaml at main --> #### What's Changed ##### 🐛 Fixes - fix: message.max.bytes should default to [`1048576`](https://togithub.com/IBM/sarama/commit/1048576) not 1 MB by [@&open-telemetry#8203;puellanivis](https://togithub.com/puellanivis) in [IBM/sarama#2804 - fix: add locking around broker throttle timer to prevent race condition by [@&open-telemetry#8203;chengsha](https://togithub.com/chengsha) in [IBM/sarama#2826 ##### 📦 Dependency updates - chore(deps): bump go.opentelemetry.io/otel/sdk from 1.23.1 to 1.24.0 in /examples/interceptors by [@&open-telemetry#8203;dependabot](https://togithub.com/dependabot) in [IBM/sarama#2816 - chore(deps): bump the golang-org-x group with 1 update by [@&open-telemetry#8203;dependabot](https://togithub.com/dependabot) in [IBM/sarama#2825 - chore(deps): bump github.com/stretchr/testify from 1.8.4 to 1.9.0 by [@&open-telemetry#8203;dependabot](https://togithub.com/dependabot) in [IBM/sarama#2822 - chore(deps): bump go.opentelemetry.io/otel/exporters/stdout/stdoutmetric from 1.23.1 to 1.24.0 in /examples/interceptors by [@&open-telemetry#8203;dependabot](https://togithub.com/dependabot) in [IBM/sarama#2815 #### New Contributors - [@&open-telemetry#8203;chengsha](https://togithub.com/chengsha) made their first contribution in [IBM/sarama#2826 **Full Changelog**: IBM/sarama@v1.43.0...v1.43.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
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.
The producer can be easily blocked due to a race condition in Broker.throttleTimer, which may result in a panic. Consider changing the type of Broker.throttleTimer to atomic.Value
Fixes #2823
Signed-off-by: chengsha shacheng@tencent.com