-
Notifications
You must be signed in to change notification settings - Fork 1.2k
fix: move TraceContext.spans from class to instance attribute #4432
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
base: release-0.3.x
Are you sure you want to change the base?
fix: move TraceContext.spans from class to instance attribute #4432
Conversation
The spans list was defined as a class-level attribute, causing all TraceContext instances to share the same list. This led to trace corruption when handling concurrent requests, as spans from different requests would be mixed together. Moving spans initialization to __init__ ensures each TraceContext instance has its own isolated spans list. Fixes trace mixing bug in concurrent request handling.
|
Hi @ashtarkb! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
nathan-weinberg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good catch - thanks for the fix!
cdoern
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, this makes sense to me
mattf
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you write a test to demonstrates the corruption, the fix, and protect us from reintroduction of this bug?
What does this PR do?
The
spanslist inTraceContextwas defined as a class-level attribute, causing allTraceContextinstances to share the same list. This led to trace corruption when handling concurrent requests, as spans from different requests would be mixed together.The bug:
class TraceContext:
spans: list[Span] = [] # Shared by ALL instances!
The fix:
Moving
spansinitialization to__init__ensures eachTraceContextinstance has its own isolated spans list:Test Plan
Before fix: 3 concurrent requests → 1 merged trace with 34 spans
After fix: 3 concurrent requests → 3 separate traces with ~10 spans each