Provide xray_recorder.capture() as context manager about aws-xray-sdk-python HOT 4 CLOSED

Thank you for the valuable feedback. I have one question that I would like to get some clarification. The capture decorator provided by the recorder is calling this function https://github.com/aws/aws-xray-sdk-python/blob/master/aws_xray_sdk/core/recorder.py#L364 which currrently does proper error handling. So based on my understanding you can use the following syntax (decorator style):

@xray_recorder.capture()
def some_function():
    print("code to trace as custom subsegment")

Is there anything missing on this code that we can improve so it can fit your use case? Or you mean to use the with style instead of a decorator?

from aws-xray-sdk-python.

The capture-decorator is fine as it is. It's perfect to get proper error handling when capturing whole functions. What we want to be able to do is to capture arbitrary parts of code inside of functions as well, with the same error handling properties as the capture-decorator does provide. That's why we would like to see the same functionality as context manager as well, as decorators can only be applied to functions, while context managers can be used inside of functions.

The example for the context manager I included above is a bit silly as the only code inside the function, which is not going to be traced, is a print function, but just imagine more complicated code flow. We e.g. have the case that we have a single function in which we want to trace multiple parts of code separately, something not possible with a decorator.

Does that answer your question?

from aws-xray-sdk-python.

Yes. Thank you for the clarification. We will cooperate this use case into future improvements and releases. A PR is always welcome.

from aws-xray-sdk-python.

This feature is released as part of 2.2.0: https://pypi.org/project/aws-xray-sdk/. Closing.

from aws-xray-sdk-python.