kafkareceiver: refactor to make consumer generic #39360
Merged
Conversation
This file contains hidden or 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
axw
force-pushed
the
kafkareceiver-generic
branch
4 times, most recently
from
b5131cd to
9317964
Compare
Remove code that is repeated for every signal, and implement a generic consumer that calls out to a signal-specific message handler. We also update all the tests to use kfake rather than mocks so we're exercising all of the receiver. These tests are parallelised, so all tests run faster than before, and with greater coverage. Finally, we add `max_fetch_wait` (defaults to 250ms) to the receiver's configuration. This was added for speeding up the tests, but may also be useful for users of the receiver.
axw
force-pushed
the
kafkareceiver-generic
branch
from
9317964 to
1b76806
Compare
|
Note to reviewer(s): I would suggest not looking at the diff, but open up kafka_exporter.go and kafka_exporter_test.go as if it's new code. |
|
Moving to draft for now, please resolve the conflict and mark ready for review again. |
MovieStoreGuy
approved these changes
Apr 22, 2025
| func (c *kafkaConsumer) consumeLoop(handler sarama.ConsumerGroupHandler) { | ||
| defer close(c.consumeLoopClosed) | ||
|
|
||
| ctx := context.Background() |
There was a problem hiding this comment.
Any reason why not to use a passed context and rely on the background context?
There was a problem hiding this comment.
All the loop does is call the consumer group's Consume method in a loop. There's only one way the loop should terminate, which is when the consumer group is closed, and that happens when Shutdown is called. Passing in a context would introduce another way the loop might exit, adding complexity.
Co-authored-by: Sean Marciniak <[email protected]>
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
Remove code that is repeated for every signal, and implement a generic consumer that calls out to a signal-specific message handler.
We also update all the tests to use kfake rather than mocks so we're exercising all of the receiver. These tests are parallelised, so all tests run faster than before, and with greater coverage.
Finally, we add
max_fetch_wait(defaults to 250ms) to the receiver's configuration. This was added for speeding up the tests, but may also be useful for users of the receiver.Link to tracking issue
N/A
Testing
See description - tests now use the real client, rather than mocks, using https://github.com/twmb/franz-go/tree/master/pkg/kfake.
Documentation
Updated README.