Add mutex for t.stopped to prevent data races #11933
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
pkg/querier/tail.go
Outdated
| @@ -52,6 +52,7 @@ type Tailer struct { | |||
| querierTailClientsMtx sync.RWMutex | |||
|
|
|||
| stopped bool | |||
| stoppedMtx sync.RWMutex | |||
There was a problem hiding this comment.
Rather than a mutex here, what do you think of using atomic.Bool? That way, there's less performance impact than mutexes and anyone who needs to use stopped in the future knows it's synchronized
MasslessParticle
approved these changes
Feb 13, 2024
rhnasc
pushed a commit
to inloco/loki
that referenced
this pull request
Apr 12, 2024
**What this PR does / why we need it**:
This addresses the data race present on the `t.stopped` variable in
`tail.go`.
```
==================
WARNING: DATA RACE
Write at 0x00c00098b198 by goroutine 568:
github.com/grafana/loki/pkg/querier.(*Tailer).close()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail.go:272 +0x104
github.com/grafana/loki/pkg/querier.TestTailer.func7.2()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail_test.go:169 +0x34
runtime.deferreturn()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/runtime/panic.go:477 +0x34
testing.tRunner()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1595 +0x1b0
testing.(*T).Run.func1()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1648 +0x40
Previous read at 0x00c00098b198 by goroutine 569:
github.com/grafana/loki/pkg/querier.(*Tailer).loop()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail.go:88 +0x13c
github.com/grafana/loki/pkg/querier.newTailer.func1()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail.go:342 +0x34
Goroutine 568 (running) created at:
testing.(*T).Run()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1648 +0x5e8
github.com/grafana/loki/pkg/querier.TestTailer()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail_test.go:158 +0x10dc
testing.tRunner()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1595 +0x1b0
testing.(*T).Run.func1()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1648 +0x40
Goroutine 569 (running) created at:
github.com/grafana/loki/pkg/querier.newTailer()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail.go:342 +0x300
github.com/grafana/loki/pkg/querier.TestTailer.func7()
/Users/progers/dev/src/github.com/grafana/loki/pkg/querier/tail_test.go:168 +0x138
testing.tRunner()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1595 +0x1b0
testing.(*T).Run.func1()
/opt/homebrew/Cellar/go/1.21.6/libexec/src/testing/testing.go:1648 +0x40
==================
```
**Which issue(s) this PR fixes**:
Relates to: grafana#8586
**Special notes for your reviewer**:
**Checklist**
- [ ] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md`
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](grafana@d10549e)
- [ ] If the change is deprecating or removing a configuration option,
update the `deprecated-config.yaml` and `deleted-config.yaml` files
respectively in the `tools/deprecated-config-checker` directory.
[Example
PR](grafana@0d4416a)
7 tasks
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.
What this PR does / why we need it:
This addresses the data race present on the
t.stoppedvariable intail.go.Which issue(s) this PR fixes:
Relates to: #8586
Special notes for your reviewer:
Checklist
CONTRIBUTING.mdguide (required)CHANGELOG.mdupdatedadd-to-release-noteslabeldocs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR