Eventhub Opentelemetry Trace exception: "'MessageProperties' object has no attribute 'setdefault'"

[erewok]

• Package Name: azure-eventhub
• Package Version: 5.10.1
• Operating System: Linux-Debian (docker container)
• Python Version: 3.11.1

Describe the bug
Today in an experiment with adding tracing spans to our EventhubProducerClient calls, I followed a helpful example provided by the package azure-core-tracing-opentelemetry.

After some tracing spans were produced, I noticed an exception in the logs (but these did not prevent events from being published):

Traceback (most recent call last):
  File "/usr/local/lib/python3.11/site-packages/opentelemetry/trace/__init__.py", line 573, in use_span
    yield span
  File "/usr/local/lib/python3.11/site-packages/azure/eventhub/_utils.py", line 181, in trace_message
    event.properties.setdefault(
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'MessageProperties' object has no attribute 'setdefault'

In the _utils.py module, there's a function called trace_message with a few lines like this:

                if not event.properties:
                    event.properties = dict()
                event.properties.setdefault(
                    b"Diagnostic-Id", message_span.get_trace_parent().encode("ascii")
                )

Here, if event.properties is truthy, then it will not be a Python dict (as in my case), and instead it's an instance of MessageProperties from the uamqp library, which has no setdefault function.

To fix it, we could indent setdefault under the if not event.properties and add an else that sets the property differently for MessageProperties.

I would be happy to submit a PR for this change if it is useful.

To Reproduce
Steps to reproduce the behavior:

1. Follow the example for instrumenting an EventhubProducerClient
2. Produce some events.
3. Load tracing span waterfall graph matching this trace id.
4. See exception screenshot below

Screenshots

Expected behavior
No exceptions when instrumenting Eventhub calls with opentelemetry tracing spans.

[kristapratico]

Hi @erewok thanks for the detailed issue, we'll take a look and get back to you as soon as possible.

[swathipil]

Hi @erewok - Thanks for the investigation! It was very helpful in helping reproduce/track down the bug. We've made a few big changes recently to the SDK, so the fix will be a little bit more complex. We're working on it right now and will keep you posted on any updates. Thanks!

[erewok]

@swathipil, great! Glad to hear it and glad that this issue was useful. Thanks for following up.

[swathipil]

Hi @erewok - The fix for this bug has been merged and will be included in the upcoming release: azure-eventhub 5.11.0.

If you'd like to test the fix in the meantime, you can build and install the wheel by:

1. Cloning the azure-sdk-for-python repo.
2. Running pip install wheel

> cd azure-sdk-for-python/sdk/eventhub/azure-eventhub
azure-sdk-for-python/sdk/eventhub/azure-eventhub> python .\setup.py bdist_wheel -d <dest_folder>

Thanks!

[ghost]

Hi @erewok. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text “/unresolve” to remove the “issue-addressed” label and continue the conversation.

[erewok]

Thanks for the update, @swathipil! I will wait until the latest version is up on PyPi. I appreciate the help.

[ghost]

Hi @erewok, since you haven’t asked that we “/unresolve” the issue, we’ll close this out. If you believe further discussion is needed, please add a comment “/unresolve” to reopen the issue.