addressing concurrency issue in Span API #1259
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
Before this change, the following would cause unintended behaviour in the Span API's add_event, update_name and set_status methods: - thread A calls set_status, locks to check if a span has ended, and releases the lock - thread B obtains the lock and ends a span - thread A continues its call of set_status This change ensures that the update operations are done with the lock being held. It's done in a decorator, but that is completely optional.
lzchen
reviewed
Oct 21, 2020
lzchen
reviewed
Oct 21, 2020
| @@ -575,15 +586,8 @@ def set_attribute(self, key: str, value: types.AttributeValue) -> None: | |||
| with self._lock: | |||
| self.attributes[key] = value | |||
There was a problem hiding this comment.
Ah yeah good point, I saw the lock here and thought it was safe from this condition, but it is not. will fix
owais
approved these changes
Oct 22, 2020
lzchen
reviewed
Oct 26, 2020
lzchen
approved these changes
Oct 26, 2020
6 tasks
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
Before this change, the following would cause unintended behaviour in the Span API's add_event, update_name and set_status methods:
This change ensures that the update operations are done with the lock being held. It's done in a decorator, but that is completely optional.
Fixes #1157
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
I updated the code in
set_statusto raise an exception when the status was updated on an already ended span and was able to reproduce the issue, it was too unreliable to write a unit test for it. The only way I managed to reproduce with about 1% of the time was to introduce a delay inset_statusChecklist: