fix log stack overflow if metadata contains circular reference #464
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.
Issue #, if available:
When segment metadata contains objects having circular reference, the segment serialization will get RecursionError exception. Then the log.exception in conversion.py will print infinite logs util hitting a new RecursionError exception, causes log flood in user application logs.
Description of changes:
Using pprint instead of normal logging. pprint can handle cycles because it tracks objects it has already visited and, when it detects a recursive reference, it prints a placeholder like <Recursion on ...> instead of recursing, preventing log flood. The output looks like
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.