Event Hubs Troubleshooting Guide

[jsquire]

Summary

In order to provide guidance for customers encountering difficulties with the client library, and support representatives working customer issues, a troubleshooting guide is needed. The guide should be focused on common scenarios for the client library and not attempt to address service-specific issues.

Scope

• Wait for the forthcoming Java troubleshooting guide to be completed and made available. (target date is April 25, 2022)

• Review email, issues, and the Java guide to identify any recurring topics.

• Address common scenarios, such as:

  • Event Hubs exceptions that can be returned, and guidance for them
  • Connectivity issues for enterprise environments. (try the web sockets transport)
  • Common event processor scenarios (too many partitions for the machine, load balancing can't keep up, etc)
  • Consider discussing specific sets of log events to capture for certain scenarios

• Write the guide in markdown format, intended for /sdk/messaging/azeventhubs/TROUBLESHOOTING.md

• Add stub guides in the root of each package pointing back at the main troubleshooting guide. (see KeyVault for inspiration)

Success Criteria

• The guide has been created and added to the repository.

References and Resources

• Azure.Identity Troubleshooting Guide
• Troubleshooting Section of the README
• Event Hubs Exceptions (legacy)
• Troubleshooting Event Hubs Connectivity

[jsquire]

//fyi: @richardpark-msft

[richardpark-msft]

This is a good thing to have - I'd prioritize Service Bus over Event Hubs, primarily because we're releasing an SB GA and haven't committed to a track 2 verson of Event Hubs yet.

[jsquire]

Agreed on prioritization; Service Bus is part of the next wave of TSGs. There will be an equivalent issue filed once those efforts kick off.

[github-actions[bot]]

Hi @jsquire, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.