exporter/file: serialize writer swap in Shutdown to stop nil-deref race#47833
Open
SAY-5 wants to merge 1 commit intoopen-telemetry:mainfrom
Open
exporter/file: serialize writer swap in Shutdown to stop nil-deref race#47833SAY-5 wants to merge 1 commit intoopen-telemetry:mainfrom
SAY-5 wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
Shutdown set e.writer = nil and then called w.shutdown() on the captured pointer, but consume* read e.writer unsynchronized. A concurrent consumeMetrics (or consumeTraces/consumeLogs/consumeProfiles) could observe nil after Shutdown's assignment and crash in file_exporter.go:36 with: panic: runtime error: invalid memory address or nil pointer dereference fileexporter.(*fileExporter).consumeMetrics ... file_exporter.go:36 +0x46 Add a sync.RWMutex guarding writer; consume* take the read lock and return a descriptive "already shut down" error when the writer has been cleared, and Shutdown takes the write lock for the swap before closing the previously-captured writer. Existing tests that still access e.writer directly keep compiling because the field type is unchanged. Fixes open-telemetry#46871. Signed-off-by: SAY-5 <SAY-5@users.noreply.github.com> Assisted-by: Claude Opus 4.7
Contributor
|
Welcome, contributor! Thank you for your contribution to opentelemetry-collector-contrib. Important reminders:
A maintainer will review your pull request soon. Thank you for helping make OpenTelemetry better! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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:
Shutdownsete.writer = niland then calledw.shutdown()on the captured pointer, butconsume*reade.writerunsynchronized. A concurrentconsumeMetrics/consumeTraces/consumeLogs/consumeProfilescould observe nil after Shutdown's assignment and crash:Fix: add a
sync.RWMutexguardingwriter.consume*take the read lock and return a descriptive"already shut down"error when the writer has been cleared;Shutdowntakes the write lock for the swap before closing the previously-captured writer. Existing tests that accesse.writerdirectly keep compiling because the field type is unchanged.Link to tracking issue: Fixes #46871
Testing:
go test ./exporter/fileexporter/... -count=1passes.Documentation: Added
.chloggen/46871-fileexporter-shutdown-race.yamlunderbug_fix.Signed-off-by: SAY-5 SAY-5@users.noreply.github.com
Assisted-by: Claude Opus 4.7