Exit the lock before logging #1317
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
codeboten
referenced
this pull request
Nov 2, 2020
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.
toumorokoshi
suggested changes
Nov 2, 2020
| logger.warning("Calling %s on an ended span.", func.__name__) | ||
| return | ||
| func(self, *args, **kwargs) | ||
| try: |
There was a problem hiding this comment.
I might consider re-writing this try/catch as an if/else instead. A good way to do this is to set a value inside the lock, and use that to determine if the logging call is needed outside.
Exception handling has a lot of overhead aside from branching.
There was a problem hiding this comment.
Good point, this just seemed like the cleanest way to implement. Have reworked to use if/else, please take a look
| raise _SpanEndedException | ||
| func(self, *args, **kwargs) | ||
| except _SpanEndedException: | ||
| logger.warning("Calling %s on an ended span.", func.__name__) |
There was a problem hiding this comment.
would it be good time to fix this message? I feel like this implies the cal occurs, even if the span has already ended.
lzchen
approved these changes
Nov 2, 2020
toumorokoshi
reviewed
Nov 2, 2020
| @@ -371,13 +371,21 @@ def _create_immutable_attributes(attributes): | |||
| return MappingProxyType(attributes.copy() if attributes else {}) | |||
|
|
|||
|
|
|||
| class _SpanEndedException(Exception): | |||
There was a problem hiding this comment.
this is unescessary, correct?
There was a problem hiding this comment.
correct, forgot to clean it up
toumorokoshi
approved these changes
Nov 2, 2020
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
Avoid logging inside a lock.
Fixes #1316
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Checklist: