Skip to content

[receiver/kafka] Use proper context for shutdown #35438

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/kafka-receiver-context-fix.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: 'bug_fix'

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: receiver/kafka

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Fix issue where shutdown could hang indefinitely.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [30789]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
5 changes: 2 additions & 3 deletions receiver/kafkareceiver/kafka_receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,8 @@ func createKafkaClient(config Config) (sarama.ConsumerGroup, error) {
return sarama.NewConsumerGroup(config.Brokers, config.GroupID, saramaConfig)
}

func (c *kafkaTracesConsumer) Start(_ context.Context, host component.Host) error {
ctx, cancel := context.WithCancel(context.Background())
c.cancelConsumeLoop = cancel
func (c *kafkaTracesConsumer) Start(ctx context.Context, host component.Host) error {
ctx, c.cancelConsumeLoop = context.WithCancel(ctx)
Comment on lines +160 to +161
Copy link
Member

@crobert-1 crobert-1 Sep 26, 2024

Choose a reason for hiding this comment

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

Suggested change
func (c *kafkaTracesConsumer) Start(ctx context.Context, host component.Host) error {
ctx, c.cancelConsumeLoop = context.WithCancel(ctx)
func (c *kafkaTracesConsumer) Start(ctx context.Context, host component.Host) error {
ctx, c.cancelConsumeLoop = context.WithCancel(ctx)

I don't think this is the solution here, as it goes against the spec's comments on context usage for components. The comment about Start here says we shouldn't use the passed in context for long-running background operations. At the moment using the passed in context doesn't cause any issues, but we don't want to go against the spec unless there's good reason.

Also, I don't believe this will resolve any kind of stuck shutdown. context.WithCancel creates a child context that can be cancelled independently of the parent. If the parent is shutdown, the child will automatically be shutdown as well, but there's no requirement vice versa. (The child can be shutdown just fine even if the parent is still running.)

I think there's else going on here, but feel free to correct me if I'm missing something here, or if you tested and confirmed this resolved the issue 🙂

Copy link
Member Author

Choose a reason for hiding this comment

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

You're right. Good explanation. I clearly didn't think this through very well.

obsrecv, err := receiverhelper.NewObsReport(receiverhelper.ObsReportSettings{
ReceiverID: c.settings.ID,
Transport: transport,
Expand Down