Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix race condition in otelcol component wrappers #2027

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

thampiotr
Copy link
Contributor

@thampiotr thampiotr commented Nov 4, 2024

PR Description

We have a general issue with OTel components where consumers may be used before the Start functions in OTel have finished running. This is because in OTel Start functions are non-blocking and sometimes do work to set things up, like it was the case for batch_processor. In Alloy, however we have Run function that is blocking for the lifetime of the component. As soon as it's called, we consider the component Running. In OTel, however, the Start function should be called and exit to consider a component running.

The solution here is to pause the Consumer until we are sure that the OTel component scheduler has called Start on all OTel components. The consumer will block any attempts to feed data to it.

Which issue(s) this PR fixes

Notes to the Reviewer

thampiotr@MacWork ~/w/alloy (update-otel-112-fix-race)> go test ./internal/component/otelcol/internal/scheduler/ -count 50 -race
ok  	github.com/grafana/alloy/internal/component/otelcol/internal/scheduler	3.543s
thampiotr@MacWork ~/w/alloy (update-otel-112-fix-race)> go test ./internal/component/otelcol/internal/lazyconsumer/ -count 50 -race
ok  	github.com/grafana/alloy/internal/component/otelcol/internal/lazyconsumer	17.495s

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@thampiotr thampiotr marked this pull request as ready for review November 5, 2024 10:10
@thampiotr thampiotr requested a review from a team as a code owner November 5, 2024 10:10
Base automatically changed from update-otel-112 to main November 5, 2024 10:20
Copy link
Contributor

@wildum wildum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this, I think that's a step in the right direction.
The logic was not super clear to me at first in the scheduler, the idea is that the components are created in the paused state so they are not paused on the first run but are always resumed after being started because they are paused when the scheduler stops running, right? Maybe we could have this explanation in the scheduler code

// called before. See Pause for more details.
func (c *Consumer) Resume() {
c.pauseMut.Unlock()
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If pause is called by accident on a paused consumer or resume on a running consumer, it will be dramatic. Should the consumer holds its state (smth like "isPaused") to avoid locking if its already paused or avoid resuming if it's already running for extra safety?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was thinking about this too, I wouldn't want to have any dramatic panics either. I've changed the implementation to handle multiple calls to Resume and Pause - it's a bit more complex, but I also wrote a lot of tests.

@@ -100,6 +129,7 @@ func (cs *Scheduler) Run(ctx context.Context) error {

level.Debug(cs.log).Log("msg", "scheduling components", "count", len(components))
components = cs.startComponents(ctx, host, components...)
cs.onResume()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if the component was created with New() instead of NewPaused() then this will panic because on the first run you will try to unlock the mut that's not locked

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it will no longer panic as calls to Resume can be repeated.

When writing code we still need to take care to use the correct paused or resumed consumer, but the consequences of a mistake shouldn't be catastrophic.

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 5, 2024
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some edits to align with the same changes in #2012 Might also be "fixed" up when the PR conflicts are resolved?

@thampiotr thampiotr marked this pull request as draft November 5, 2024 17:36
@thampiotr thampiotr removed the type/docs Docs Squad label across all Grafana Labs repos label Nov 12, 2024
@thampiotr thampiotr marked this pull request as ready for review November 12, 2024 12:51
@thampiotr thampiotr changed the title Fix race condition in otelcol processors Fix race condition in otelcol component wrappers Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants