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)

• 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/eventhub/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 by May 15.

• The Event Hubs feature crew has been notified that the troubleshooting guide is complete for Python.

References and Resources

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

[kashifkhan]

Closed with PR #24697