[Event Hubs] Include inner exception output for EventHubsException.ToString()

[dperez83]

Library name and version

Azure.Messaging.EventHubs.Processor 5.7.5

Describe the bug

Azure.Messaging.EventHubs EventHubsException.ToString() overrides the default System.Exception.ToString() and does not outputs the InnerException details.

Expected behavior

To output the InnerException details.

Actual behavior

Only this is output, and no InnerException detail.

Azure.Messaging.EventHubs.EventHubsException(GeneralError): An error was encountered while executing developer-provided code to process events. On most hosts, this will fault the task responsible for partition processing, causing it to be restarted from the last checkpoint. On some hosts, it may crash the process. It is very strongly advised that all developer-provided code include a try/catch wrapper and ensure that no exceptions are allowed to propagate up the stack. Exception details can be found in the inner exception. (vdqgadeviothub). For troubleshooting information, see https://aka.ms/azsdk/net/eventhubs/exceptions/troubleshoot

Reproduction Steps

Throw a Azure.Messaging.EventHubs EventHubsException with an InnerException

Environment

.NET 6.0

[jsquire]

Hi @dperez83. Thank you for your feedback. I agree that we should be emulating the base exception behavior and including the inner exception, if it exists. I've added this to our backlog.

One thing that I'd like to mention is that if you are seeing this exception, it's a sign that your event processing handler is not following the recommended guidance. We strongly recommend that you ensure that your code for any of the processor handlers be wrapped in a try/catch block and ensure that no exceptions leak. More context can be found in: Exceptions in handlers.