Skip to content

Commit bcf11d3

Browse files
Copilotswathipilkashifkhanjsquire
authored
Add comprehensive TROUBLESHOOTING.md file for Azure Service Bus Python SDK (#41352)
* Initial plan for issue * Add comprehensive TROUBLESHOOTING.md for Azure Service Bus Co-authored-by: swathipil <[email protected]> * Replace connection string with Azure Identity credential auth in logging example Co-authored-by: swathipil <[email protected]> * Update TROUBLESHOOTING.md based on PR feedback Co-authored-by: kashifkhan <[email protected]> * Update WebSockets example to explicitly show connection string usage Co-authored-by: kashifkhan <[email protected]> * Update WebSockets example to use Azure Identity instead of connection string Co-authored-by: swathipil <[email protected]> * Add comprehensive content sections to TROUBLESHOOTING.md Co-authored-by: swathipil <[email protected]> * Complete TROUBLESHOOTING.md with async operations and enhanced content Co-authored-by: swathipil <[email protected]> * Address multiple review comments - remove sections, move sections, update links Co-authored-by: swathipil <[email protected]> * Complete review feedback implementation - remove async sections, update threading guidance Co-authored-by: swathipil <[email protected]> * Address remaining review comments - remove unnecessary sections and reorganize structure Co-authored-by: swathipil <[email protected]> * Fix async example to match exact format requested in review comments Co-authored-by: swathipil <[email protected]> * Fix TROUBLESHOOTING.md formatting and content issues based on review feedback Co-authored-by: swathipil <[email protected]> * Revert previous 5 commits as requested Co-authored-by: swathipil <[email protected]> * Significantly reduce TROUBLESHOOTING.md length and focus on essential troubleshooting Co-authored-by: swathipil <[email protected]> * Remove sections entirely rather than condensing - address review feedback Co-authored-by: swathipil <[email protected]> * Fix formatting issues and clean up extra blank lines Co-authored-by: swathipil <[email protected]> * Undo last 3 commits - restore TROUBLESHOOTING.md to previous state Co-authored-by: swathipil <[email protected]> * address comments * address rest of comments * fix links * Address review comments: improve retry info, fix headers, add WebSockets suggestion, and clean up formatting Co-authored-by: jsquire <[email protected]> * Remove threading and concurrency section - not Service Bus specific Co-authored-by: swathipil <[email protected]> * Remove client options references from connection string troubleshooting Co-authored-by: swathipil <[email protected]> * Undo changes from commits b684064 and 80409e2 - restore threading section and client options references Co-authored-by: swathipil <[email protected]> * double check Jesse's comments are addressed * apply jesses comments to other sb docs * libbas comments --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: swathipil <[email protected]> Co-authored-by: kashifkhan <[email protected]> Co-authored-by: swathipil <[email protected]> Co-authored-by: jsquire <[email protected]>
1 parent 0487c8d commit bcf11d3

File tree

5 files changed

+423
-79
lines changed

5 files changed

+423
-79
lines changed

sdk/servicebus/azure-servicebus/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,11 @@ To interact with these resources, one should be familiar with the following SDK
9595

9696
### Thread safety
9797

98-
We do not guarantee that the ServiceBusClient, ServiceBusSender, and ServiceBusReceiver are thread-safe or coroutine-safe. We do not recommend reusing these instances across threads or sharing them between coroutines. It is up to the running application to use these classes in a concurrency-safe manner.
98+
We do not guarantee that the `ServiceBusClient`, `ServiceBusSender`, and `ServiceBusReceiver` are thread-safe or coroutine-safe. We do not recommend reusing these instances across threads or sharing them between coroutines. It is up to the running application to use these classes in a concurrency-safe manner.
9999

100100
The data model type, `ServiceBusMessageBatch` is not thread-safe or coroutine-safe. It should not be shared across threads nor used concurrently with client methods.
101101

102-
For scenarios requiring concurrent sending from multiple threads, ensure proper thread-safety management using mechanisms like threading.Lock(). **Note:** Native async APIs should be used instead of running in a ThreadPoolExecutor, if possible.
102+
For scenarios requiring concurrent sending from multiple threads, ensure proper thread-safety management using mechanisms like `threading.Lock()`. **Note:** Native async APIs should be used instead of running in a `ThreadPoolExecutor`, if possible.
103103
```python
104104
import threading
105105
from concurrent.futures import ThreadPoolExecutor
@@ -128,7 +128,7 @@ with client:
128128
executor.submit(send_batch, i, sender)
129129
```
130130

131-
For scenarios requiring concurrent sending in asyncio applications, ensure proper coroutine-safety management using mechanisms like asyncio.Lock()
131+
For scenarios requiring concurrent sending in asyncio applications, ensure proper coroutine-safety management using mechanisms like `asyncio.Lock()`.
132132
```python
133133
import asyncio
134134
from azure.servicebus.aio import ServiceBusClient

0 commit comments

Comments
 (0)